diff --git a/doc/新建文本文档.txt b/doc/新建文本文档.txt new file mode 100644 index 0000000..b65cb5c --- /dev/null +++ b/doc/新建文本文档.txt @@ -0,0 +1 @@ +wangyuhang diff --git a/src/main/java/net/micode/notes/data/Contact.java b/src/main/java/net/micode/notes/data/Contact.java index d97ac5d..708ea9f 100644 --- a/src/main/java/net/micode/notes/data/Contact.java +++ b/src/main/java/net/micode/notes/data/Contact.java @@ -26,46 +26,49 @@ import android.util.Log; import java.util.HashMap; public class Contact { - private static HashMap sContactCache; - private static final String TAG = "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 = '+')"; - + + " 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, + 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); + sContactCache.put(phoneNumber, name);//把找到的联系人电话和名字移到缓存列表中 return name; } catch (IndexOutOfBoundsException e) { - Log.e(TAG, " Cursor get string error " + e.toString()); + Log.e(TAG, " Cursor get string error " + e.toString());//异常处理 return null; } finally { - cursor.close(); + cursor.close();//关闭数据库的访问 } } else { + //数据库不存在或没找到此联系电话 Log.d(TAG, "No contact matched with number:" + phoneNumber); return null; } diff --git a/src/main/java/net/micode/notes/data/Notes.java b/src/main/java/net/micode/notes/data/Notes.java index f240604..b3aa269 100644 --- a/src/main/java/net/micode/notes/data/Notes.java +++ b/src/main/java/net/micode/notes/data/Notes.java @@ -15,26 +15,33 @@ */ package net.micode.notes.data; - +/*uri是统一资源标志符（Uniform Resource Identifier），而在这个类中定义了各种Uri常量， +以便在其他的类中调用。Uri用处很多，涉及到安卓权限，比如通过Uri可以： +直接拨打电话、调出拨打电话界面、调WEB浏览器、卸载、安装、播放、调用发邮件、直接发邮件等系统功能 +Android上可用的每种资源 -包括 图像、视频片段、音频资源等都可以用Uri来表示*/ import android.net.Uri; public class Notes { - public static final String AUTHORITY = "micode_notes"; - public static final String TAG = "Notes"; - public static final int TYPE_NOTE = 0; - public static final int TYPE_FOLDER = 1; - public static final int TYPE_SYSTEM = 2; + /*便签数据库,该类主要实现了对便签的相关属性包括：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 - * {@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 + * 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"; @@ -42,28 +49,30 @@ public class Notes { 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; - public static final int TYPE_WIDGET_4X = 1; + 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 + * Uri to query all notes and folders（统一资源标识符查询便签和文件夹） */ public static final Uri CONTENT_NOTE_URI = Uri.parse("content://" + AUTHORITY + "/note"); /** - * Uri to query data + * 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 + * The unique ID for a row（主键） *

Type: INTEGER (long)

*/ public static final String ID = "_id"; @@ -72,7 +81,7 @@ public class Notes { * The parent's id for note or folder *

Type: INTEGER (long)

*/ - public static final String PARENT_ID = "parent_id"; + public static final String PARENT_ID = "parent_id";//父节点id /** * Created data for note or folder @@ -84,14 +93,14 @@ public class Notes { * Latest modified date *

Type: INTEGER (long)

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

Type: INTEGER (long)

*/ - public static final String ALERTED_DATE = "alert_date"; + public static final String ALERTED_DATE = "alert_date";//更改日期 /** * Folder's name or text content of note @@ -122,7 +131,7 @@ public class Notes { * note, it has at least one attachment *

Type: INTEGER

*/ - public static final String HAS_ATTACHMENT = "has_attachment"; + public static final String HAS_ATTACHMENT = "has_attachment";//是否有附件 /** * Folder's count of notes @@ -140,78 +149,78 @@ public class Notes { * The last sync id *

Type: INTEGER (long)

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

Type: INTEGER

*/ - public static final String LOCAL_MODIFIED = "local_modified"; + 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"; + public static final String ORIGIN_PARENT_ID = "origin_parent_id";//父节点id在移到临时文件夹之前 /** * The gtask id *

Type : TEXT

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

Type : INTEGER (long)

*/ - public static final String VERSION = "version"; + 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"; + public static final String ID = "_id";//每一行id /** - * The MIME type of the item represented by this row. + * The MIME type of the item represented by this row.（这行代表的mime类型） *

Type: Text

*/ - public static final String MIME_TYPE = "mime_type"; + 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"; + 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"; + public static final String CREATED_DATE = "created_date";//创建时间 /** * Latest modified date *

Type: INTEGER (long)

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

Type: TEXT

*/ - public static final String CONTENT = "content"; - + 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 @@ -242,38 +251,42 @@ public class Notes { } 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; + public static final String MODE = DATA1;//继承DATA1 - public static final int MODE_CHECK_LIST = 1; + 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_TYPE = "vnd.android.cursor.dir/text_note";//内容类型 - public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/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"); + 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; + 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 PHONE_NUMBER = DATA3;//电话号码 - public static final String CONTENT_TYPE = "vnd.android.cursor.dir/call_note"; + 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 String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/call_note";//内容项目类型 - public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note"); + public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/call_note");//content 的索引标识符 } } diff --git a/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java b/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java index ffe5d57..02164f4 100644 --- a/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java +++ b/src/main/java/net/micode/notes/data/NotesDatabaseHelper.java @@ -13,7 +13,6 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - package net.micode.notes.data; import android.content.ContentValues; @@ -26,22 +25,23 @@ 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 String DB_NAME = "note.db";//数据库名字 - private static final int DB_VERSION = 4; + 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 TAG = "NotesDatabaseHelper";//定义该类的名称 + private static NotesDatabaseHelper mInstance;//实例化对象 + //创建标签表表头并初始化 private static final String CREATE_NOTE_TABLE_SQL = "CREATE TABLE " + TABLE.NOTE + "(" + NoteColumns.ID + " INTEGER PRIMARY KEY," + @@ -62,7 +62,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { 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," + @@ -77,7 +77,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { 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 + ");"; @@ -85,6 +85,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { /** * 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 + @@ -97,6 +98,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { /** * 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 + @@ -110,6 +112,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { /** * 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 + @@ -122,6 +125,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { /** * 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 + @@ -135,6 +139,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { /** * 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 + @@ -148,6 +153,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { /** * 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 + @@ -161,6 +167,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { /** * 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 + @@ -174,6 +181,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { /** * 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 + @@ -185,6 +193,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { /** * 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 + @@ -196,6 +205,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { /** * 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 + @@ -205,18 +215,18 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { " 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"); @@ -234,49 +244,49 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { 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(); + ContentValues values = new ContentValues();//创建对象记录基本数据的值 /** - * call record foler for call notes + * call record foler for call notes（呼叫记录文件夹） */ - values.put(NoteColumns.ID, Notes.ID_CALL_RECORD_FOLDER); - values.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); - db.insert(TABLE.NOTE, null, values); + 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 + * root folder which is default folder（默认文件夹） */ - values.clear(); + 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 + * temporary folder which is used for moving note（为移动note而设置的临时文件夹） */ - values.clear(); + 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 + * create trash folder（创建垃圾回收文件夹） */ - values.clear(); + 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"); @@ -286,7 +296,8 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { 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); @@ -294,52 +305,52 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { return mInstance; } - @Override + //onCreat方法创建note和data表 public void onCreate(SQLiteDatabase db) { createNoteTable(db); createDataTable(db); } - @Override + //当打开数据库时传入的版本号与当前的版本号不同时会调用该方法，更新版本 public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { - boolean reCreateTriggers = false; - boolean skipV2 = false; + boolean reCreateTriggers = false;//是否重建 + boolean skipV2 = false;//是否从V2升级到V3 - if (oldVersion == 1) { - upgradeToV2(db); + if (oldVersion == 1) {//版本是1 + upgradeToV2(db);//更新到2 skipV2 = true; // this upgrade including the upgrade from v2 to v3 oldVersion++; } - if (oldVersion == 2 && !skipV2) { - upgradeToV3(db); + if (oldVersion == 2 && !skipV2) {//版本是2且没有跳过2号版本，就更新到3号版本 + upgradeToV3(db);//更新到3 reCreateTriggers = true; oldVersion++; } - if (oldVersion == 3) { - upgradeToV4(db); + if (oldVersion == 3) {//版本是3 + upgradeToV4(db);//更新到4 oldVersion++; } - if (reCreateTriggers) { + if (reCreateTriggers) {//如果重新创建触发器，则重新创建两个表的触发器 reCreateNoteTableTriggers(db); reCreateDataTableTriggers(db); } - if (oldVersion != newVersion) { + 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"); @@ -354,7 +365,7 @@ public class NotesDatabaseHelper extends SQLiteOpenHelper { 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/src/main/java/net/micode/notes/data/NotesProvider.java b/src/main/java/net/micode/notes/data/NotesProvider.java index edb0a60..eac119f 100644 --- a/src/main/java/net/micode/notes/data/NotesProvider.java +++ b/src/main/java/net/micode/notes/data/NotesProvider.java @@ -33,15 +33,14 @@ 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; - - private NotesDatabaseHelper mHelper; + private static final UriMatcher mMatcher;//UriMatcher是Android提供的用来操作Uri的工具类 - private static final String TAG = "NotesProvider"; + 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; @@ -49,22 +48,25 @@ public class NotesProvider extends ContentProvider { private static final int URI_SEARCH = 5; private static final int URI_SEARCH_SUGGEST = 6; - + //将以下这些变量放在static模块中，只初始化一次，提高运行速度以及减少空间浪费。将各个Uri与其代号关联在一起 static { - mMatcher = new UriMatcher(UriMatcher.NO_MATCH); + 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. + * 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 + "," @@ -72,116 +74,124 @@ public class NotesProvider extends ContentProvider { + 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; - @Override + //创建一个便签数据库助手mHelper public boolean onCreate() { mHelper = NotesDatabaseHelper.getInstance(getContext()); return true; } - @Override + //查询uri在数据库中对应的位置 public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) { - Cursor c = null; - SQLiteDatabase db = mHelper.getReadableDatabase(); + Cursor c = null;//函数返回对象 + /*getReadableDatabase()方法是先以读写方式打开数据库，如果数据库的磁盘空间满了，就会打开失败，当打开失败后会继续尝试以只读方式打开数据库。如果该问题成功解决，则只读数据库对象就会关闭，然后返回一个可读写的数据库对象。*/ + SQLiteDatabase db = mHelper.getReadableDatabase();//向数据库读操作 String id = null; switch (mMatcher.match(uri)) { - case URI_NOTE: + case URI_NOTE://匹配到标签的uri c = db.query(TABLE.NOTE, projection, selection, selectionArgs, null, null, - sortOrder); + sortOrder);//查询的表返回列行如何分组过滤条件，数据库查询语句 break; - case URI_NOTE_ITEM: - id = uri.getPathSegments().get(1); + 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); + + parseSelection(selection), selectionArgs, null, null, sortOrder);//查询的表返回列行如何分组过滤条件，数据库查询语句 break; - case URI_DATA: + case URI_DATA://匹配到数据的uri c = db.query(TABLE.DATA, projection, selection, selectionArgs, null, null, - sortOrder); + sortOrder);//查询的表返回列行如何分组过滤条件，数据库查询语句 break; - case URI_DATA_ITEM: - id = uri.getPathSegments().get(1); + 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); + + parseSelection(selection), selectionArgs, null, null, sortOrder);//数据库查询语句 break; - case URI_SEARCH: - case URI_SEARCH_SUGGEST: + 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 (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()); + Log.e(TAG, "got exception: " + ex.toString());//出错抛出异常 } break; default: - throw new IllegalArgumentException("Unknown URI " + uri); + throw new IllegalArgumentException("Unknown URI " + uri);//无法匹配上述的uri，抛出错误 } if (c != null) { + //若getContentResolver发生变化，就接收通知 c.setNotificationUri(getContext().getContentResolver(), uri); } return c; } - @Override + //插入一个新的uri public Uri insert(Uri uri, ContentValues values) { - SQLiteDatabase db = mHelper.getWritableDatabase(); + 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); + 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); + 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()); + Log.d(TAG, "Wrong data format without note id:" + values.toString());//信息不含主键抛出异常错误 } - insertedId = dataId = db.insert(TABLE.DATA, null, values); + insertedId = dataId = db.insert(TABLE.DATA, null, values);//向数据表插入一个uri break; default: - throw new IllegalArgumentException("Unknown URI " + uri); + throw new IllegalArgumentException("Unknown URI " + uri);//不匹配的uri } - // Notify the note 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 + // 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); + return ContentUris.withAppendedId(uri, insertedId);//返回插入uri的路径 } - @Override + //删除一个uri public int delete(Uri uri, String selection, String[] selectionArgs) { int count = 0; String id = null; @@ -189,8 +199,8 @@ public class NotesProvider extends ContentProvider { boolean deleteData = false; switch (mMatcher.match(uri)) { case URI_NOTE: - selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 "; - count = db.delete(TABLE.NOTE, selection, selectionArgs); + selection = "(" + selection + ") AND " + NoteColumns.ID + ">0 ";//要删除的note的信息 + count = db.delete(TABLE.NOTE, selection, selectionArgs);//删除且返回数量 break; case URI_NOTE_ITEM: id = uri.getPathSegments().get(1); @@ -200,11 +210,13 @@ public class NotesProvider extends ContentProvider { */ long noteId = Long.valueOf(id); if (noteId <= 0) { + // ID小于0表示是系统文件夹，不能删除 break; } count = db.delete(TABLE.NOTE, - NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs); + NoteColumns.ID + "=" + id + parseSelection(selection), selectionArgs);//删除且返回数量 break; + //以下两个与上两个相同 case URI_DATA: count = db.delete(TABLE.DATA, selection, selectionArgs); deleteData = true; @@ -216,34 +228,35 @@ public class NotesProvider extends ContentProvider { deleteData = true; break; default: - throw new IllegalArgumentException("Unknown URI " + uri); + throw new IllegalArgumentException("Unknown URI " + uri);//不匹配的uri } if (count > 0) { - if (deleteData) { + if (deleteData) {//如果真的删除了数据，则要求监听器对观察者发送通知 getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); } - getContext().getContentResolver().notifyChange(uri, null); + getContext().getContentResolver().notifyChange(uri, null);//对所有修改进行通知 } - return count; + return count;//返回删除数量 } - @Override + //更新一个uri public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) { - int count = 0; + 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); + increaseNoteVersion(-1, selection, selectionArgs);//先升级版本再更新 + count = db.update(TABLE.NOTE, values, selection, selectionArgs);//更新且返回数量 break; case URI_NOTE_ITEM: - id = uri.getPathSegments().get(1); + 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; @@ -255,23 +268,24 @@ public class NotesProvider extends ContentProvider { updateData = true; break; default: - throw new IllegalArgumentException("Unknown URI " + uri); + throw new IllegalArgumentException("Unknown URI " + uri);//不匹配uri } if (count > 0) { - if (updateData) { + if (updateData) {//如果对数据进行了更新，则要求监听器对观察者发送通知 getContext().getContentResolver().notifyChange(Notes.CONTENT_NOTE_URI, null); } - getContext().getContentResolver().notifyChange(uri, null); + getContext().getContentResolver().notifyChange(uri, null);//对所有更新进行通知 } - return count; + 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); @@ -282,22 +296,23 @@ public class NotesProvider extends ContentProvider { if (id > 0 || !TextUtils.isEmpty(selection)) { sql.append(" WHERE "); } - if (id > 0) { + 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) { + public String getType(Uri uri) {//获取uri的数据类型，实际永远返回null // TODO Auto-generated method stub return null; } diff --git a/src/main/java/net/micode/notes/gtask/data/MetaData.java b/src/main/java/net/micode/notes/gtask/data/MetaData.java index 3a2050b..81f8b8a 100644 --- a/src/main/java/net/micode/notes/gtask/data/MetaData.java +++ b/src/main/java/net/micode/notes/gtask/data/MetaData.java @@ -25,14 +25,14 @@ import org.json.JSONException; import org.json.JSONObject; -public class MetaData extends Task { - private final static String TAG = MetaData.class.getSimpleName(); +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) { + public void setMeta(String gid, JSONObject metaInfo) {//获取相关联的Gid try { - metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid); + metaInfo.put(GTaskStringUtils.META_HEAD_GTASK_ID, gid);//将这对键值放入metaInfo这个jsonobject对象中 } catch (JSONException e) { Log.e(TAG, "failed to put related gid"); } @@ -42,19 +42,19 @@ public class MetaData extends Task { public String getRelatedGid() { return mRelatedGid; - } + }//判断当前数据是否为空，若为空则返回真即值得保存 @Override public boolean isWorthSaving() { return getNotes() != null; - } + }//调用父类Task中的setContentByRemoteJSON ()函数，使用远程json数据对象设置元数据内 @Override - public void setContentByRemoteJSON(JSONObject js) { + public void setContentByRemoteJSON(JSONObject js) {//调用父类Task中的setContentByRemoteJSON ()函数，使用远程json数据对象设置元数据内容 super.setContentByRemoteJSON(js); if (getNotes() != null) { try { - JSONObject metaInfo = new JSONObject(getNotes().trim()); + 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"); @@ -64,18 +64,18 @@ public class MetaData extends Task { } @Override - public void setContentByLocalJSON(JSONObject js) { + 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() { + public JSONObject getLocalJSONFromContent() {//从元数据内容中获取本地json对象，抛出异常 throw new IllegalAccessError("MetaData:getLocalJSONFromContent should not be called"); } @Override - public int getSyncAction(Cursor c) { + public int getSyncAction(Cursor c) {//获取同步动作状态 throw new IllegalAccessError("MetaData:getSyncAction should not be called"); } diff --git a/src/main/java/net/micode/notes/gtask/data/Node.java b/src/main/java/net/micode/notes/gtask/data/Node.java index 63950e0..8f958d3 100644 --- a/src/main/java/net/micode/notes/gtask/data/Node.java +++ b/src/main/java/net/micode/notes/gtask/data/Node.java @@ -20,9 +20,9 @@ import android.database.Cursor; import org.json.JSONObject; -public abstract class Node { +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; @@ -40,22 +40,22 @@ public abstract class Node { public static final int SYNC_ACTION_ERROR = 8; private String mGid; - - private String mName; + //记录最后一次修改时间 + private String mName;//bool类型，表明表征是否被删除 private long mLastModified; private boolean mDeleted; - public Node() { + 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); @@ -69,11 +69,11 @@ public abstract class Node { public void setGid(String gid) { this.mGid = gid; } - +//行到底部，都是一些赋值和返回值函数，即对构造函数中的对象进行赋值或者获取对象的具体内容。 public void setName(String name) { this.mName = name; } - +//设置删除标识 public void setLastModified(long lastModified) { this.mLastModified = lastModified; } @@ -97,5 +97,5 @@ public abstract class Node { public boolean getDeleted() { return this.mDeleted; } - +//获取删除标识 } diff --git a/src/main/java/net/micode/notes/gtask/data/SqlData.java b/src/main/java/net/micode/notes/gtask/data/SqlData.java index d3ec3be..b81b51e 100644 --- a/src/main/java/net/micode/notes/gtask/data/SqlData.java +++ b/src/main/java/net/micode/notes/gtask/data/SqlData.java @@ -35,18 +35,18 @@ import org.json.JSONException; import org.json.JSONObject; -public class SqlData { +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[] { + 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; @@ -56,24 +56,24 @@ public class SqlData { 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; - - public SqlData(Context context) { +//contenvalues只能存储基本类型的数据，像string，int之类的 + public SqlData(Context context) {//构造函数，初始化数据，参数类型为Context mContentResolver = context.getContentResolver(); - mIsCreate = true; + mIsCreate = true;//mIsCreate为TRUE是这种构造方式的标志 mDataId = INVALID_ID; mDataMimeType = DataConstants.NOTE; mDataContent = ""; @@ -81,7 +81,7 @@ public class SqlData { mDataContentData3 = ""; mDiffDataValues = new ContentValues(); } - +//第二种SqlData的构造方式，通过cursor来获取数据 public SqlData(Context context, Cursor c) { mContentResolver = context.getContentResolver(); mIsCreate = false; @@ -89,7 +89,7 @@ public class SqlData { mDiffDataValues = new ContentValues(); } - private void loadFromCursor(Cursor c) { + 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); @@ -97,14 +97,14 @@ public class SqlData { mDataContentData3 = c.getString(DATA_CONTENT_DATA_3_COLUMN); } - public void setContent(JSONObject js) throws JSONException { + 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) + 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); @@ -116,12 +116,12 @@ public class SqlData { 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; + mDataContentData1 = dataContentData1;//共享数据同步后，共享1类型数据等于该1类型数据 String dataContentData3 = js.has(DataColumns.DATA3) ? js.getString(DataColumns.DATA3) : ""; if (mIsCreate || !mDataContentData3.equals(dataContentData3)) { @@ -129,7 +129,7 @@ public class SqlData { } mDataContentData3 = dataContentData3; } - +//获取共享数据内容及提供异常抛出与处理机制 public JSONObject getContent() throws JSONException { if (mIsCreate) { Log.e(TAG, "it seems that we haven't created this in database yet"); @@ -143,12 +143,12 @@ public class SqlData { 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); + mDiffDataValues.remove(DataColumns.ID);//更新共享数据，键为NOTE_ID，值为noteId } mDiffDataValues.put(DataColumns.NOTE_ID, noteId); @@ -162,28 +162,28 @@ public class SqlData { } else { if (mDiffDataValues.size() > 0) { int result = 0; - if (!validateVersion) { + if (!validateVersion) {//如果版本还没确认，则结果记录下的只是data的ID，还有data内容 result = mContentResolver.update(ContentUris.withAppendedId( Notes.CONTENT_DATA_URI, mDataId), mDiffDataValues, null, null); } else { - result = mContentResolver.update(ContentUris.withAppendedId( + 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(); + mDiffDataValues.clear();//回到初始化，清空，表示已经更新 mIsCreate = false; } public long getId() { return mDataId; - } + }//获取当前id } diff --git a/src/main/java/net/micode/notes/gtask/data/SqlNote.java b/src/main/java/net/micode/notes/gtask/data/SqlNote.java index 79a4095..6cc5814 100644 --- a/src/main/java/net/micode/notes/gtask/data/SqlNote.java +++ b/src/main/java/net/micode/notes/gtask/data/SqlNote.java @@ -38,12 +38,12 @@ import org.json.JSONObject; import java.util.ArrayList; -public class SqlNote { +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[] { + 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, @@ -51,7 +51,7 @@ public class SqlNote { 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; @@ -86,7 +86,7 @@ public class SqlNote { public static final int VERSION_COLUMN = 16; - private Context mContext; + private Context mContext;//以下定义了17个内部变量，其中12个可以由content获得，5个需要初始化为0或者new private ContentResolver mContentResolver; @@ -121,59 +121,59 @@ public class SqlNote { private ContentValues mDiffNoteValues; private ArrayList mDataList; - - public SqlNote(Context context) { +//SqlNote第一种构造方法，只通过上下文context构造 + public SqlNote(Context context) {//构造函数参数只有context，对所有的变量进行初始化 mContext = context; mContentResolver = context.getContentResolver(); - mIsCreate = true; - mId = INVALID_ID; + mIsCreate = true;//对象不存在，是要新建的 + mId = INVALID_ID;//无效用户 mAlertDate = 0; - mBgColorId = ResourceParser.getDefaultBgId(context); - mCreatedDate = System.currentTimeMillis(); + mBgColorId = ResourceParser.getDefaultBgId(context);//系统默认背景 + mCreatedDate = System.currentTimeMillis();//调用系统函数获取创建时间 mHasAttachment = 0; mModifiedDate = System.currentTimeMillis(); mParentId = 0; mSnippet = ""; mType = Notes.TYPE_NOTE; - mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID; - mWidgetType = Notes.TYPE_WIDGET_INVALIDE; + mWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID;//控件Id初始化 + mWidgetType = Notes.TYPE_WIDGET_INVALIDE;//控件类型初始化 mOriginParent = 0; mVersion = 0; - mDiffNoteValues = new ContentValues(); - mDataList = new ArrayList(); + mDiffNoteValues = new ContentValues();//新建一个NoteValues值，用来记录改变的values + mDataList = new ArrayList();// 新建一个data的列表 } - public SqlNote(Context context, Cursor c) { + 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) + if (mType == Notes.TYPE_NOTE)//如果是note类型，则调用下面的 loadDataContent()函数，加载数据内容 loadDataContent(); mDiffNoteValues = new ContentValues(); } - public SqlNote(Context context, long id) { + public SqlNote(Context context, long id) {//构造函数，两个参数 mContext = context; mContentResolver = context.getContentResolver(); mIsCreate = false; - loadFromCursor(id); + loadFromCursor(id);//调用下面的 loadFromCursor函数，通过ID从光标处加载数据 mDataList = new ArrayList(); - if (mType == Notes.TYPE_NOTE) + if (mType == Notes.TYPE_NOTE)//如果是数据是便签类型，则加载数据内容 loadDataContent(); mDiffNoteValues = new ContentValues(); } - - private void loadFromCursor(long id) { +//通过id从cursor加载数据 + private void loadFromCursor(long id) {//通过id从光标处加载数据 Cursor c = null; - try { + try {//通过try避免异常 c = mContentResolver.query(Notes.CONTENT_NOTE_URI, PROJECTION_NOTE, "(_id=?)", new String[] { String.valueOf(id) - }, null); - if (c != null) { + }, null);//如果获取成功，则cursor移动到下一条记录，并加载该记录 + if (c != null) {//代码块：如果有内容就将移入文档，并再次等待光标的内容 c.moveToNext(); loadFromCursor(c); } else { @@ -184,9 +184,9 @@ public class SqlNote { c.close(); } } - - private void loadFromCursor(Cursor c) { - mId = c.getLong(ID_COLUMN); +//通过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); @@ -199,22 +199,22 @@ public class SqlNote { mWidgetType = c.getInt(WIDGET_TYPE_COLUMN); mVersion = c.getLong(VERSION_COLUMN); } - - private void loadDataContent() { +//取ID对应content内容，如果查询到该note的id确实有对应项，即cursor有对应，获取ID对应content内容 + private void loadDataContent() {//通过content机制获取共享数据并加载到数据库当前游标处 Cursor c = null; mDataList.clear(); - try { - c = mContentResolver.query(Notes.CONTENT_DATA_URI, SqlData.PROJECTION_DATA, + 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) { + 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); + SqlData data = new SqlData(mContext, c);//将获取数据存入数据表 mDataList.add(data); } } else { @@ -225,23 +225,23 @@ public class SqlNote { c.close(); } } - - public boolean setContent(JSONObject js) { + //设置content共享信息 + public boolean setContent(JSONObject js) {//设置通过content机制用于共享的数据信息 try { JSONObject note = js.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); - if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) { + if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_SYSTEM) {//不能设置系统文件 Log.w(TAG, "cannot set system folder"); - } else if (note.getInt(NoteColumns.TYPE) == Notes.TYPE_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 + String snippet = note.has(NoteColumns.SNIPPET) ? note//如果共享数据存在摘要，则将其赋给声明的 snippet变量，否则变量为空 .getString(NoteColumns.SNIPPET) : ""; - if (mIsCreate || !mSnippet.equals(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; + : Notes.TYPE_NOTE;//以下操作都和上面对snippet的操作一样，一起根据共享的数据设置SqlNote内容的上述17项 if (mIsCreate || mType != type) { mDiffNoteValues.put(NoteColumns.TYPE, type); } @@ -252,21 +252,21 @@ public class SqlNote { if (mIsCreate || mId != id) { mDiffNoteValues.put(NoteColumns.ID, id); } - mId = id; + mId = id;//将该ID覆盖原ID - long alertDate = note.has(NoteColumns.ALERTED_DATE) ? note + 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 + 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; + mBgColorId = bgColorId;/将该背景颜色覆盖原背景颜色 long createDate = note.has(NoteColumns.CREATED_DATE) ? note .getLong(NoteColumns.CREATED_DATE) : System.currentTimeMillis(); @@ -275,66 +275,66 @@ public class SqlNote { } mCreatedDate = createDate; - int hasAttachment = note.has(NoteColumns.HAS_ATTACHMENT) ? note + 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 + 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; + mModifiedDate = modifiedDate;//将该父节点ID覆盖原父节点ID long parentId = note.has(NoteColumns.PARENT_ID) ? note .getLong(NoteColumns.PARENT_ID) : 0; - if (mIsCreate || mParentId != parentId) { + if (mIsCreate || mParentId != parentId) {//如果只是通过上下文对note进行数据库操作，或者该文本片段与原文本片段不相同， mDiffNoteValues.put(NoteColumns.PARENT_ID, parentId); } mParentId = parentId; - String snippet = note.has(NoteColumns.SNIPPET) ? note + 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) + int type = note.has(NoteColumns.TYPE) ? note.getInt(NoteColumns.TYPE)//对类型操作 : Notes.TYPE_NOTE; - if (mIsCreate || mType != type) { + if (mIsCreate || mType != type) {//如果只是通过上下文对note进行数据库操作，或者该文件类型与原文件类型不相同 mDiffNoteValues.put(NoteColumns.TYPE, type); } mType = type; - int widgetId = note.has(NoteColumns.WIDGET_ID) ? note.getInt(NoteColumns.WIDGET_ID) + int widgetId = note.has(NoteColumns.WIDGET_ID) ? note.getInt(NoteColumns.WIDGET_ID)//对控件操作 : AppWidgetManager.INVALID_APPWIDGET_ID; - if (mIsCreate || mWidgetId != widgetId) { + if (mIsCreate || mWidgetId != widgetId) {//如果只是通过上下文对note进行数据库操作，或者该小部件ID与原小部件ID不相同 mDiffNoteValues.put(NoteColumns.WIDGET_ID, widgetId); } mWidgetId = widgetId; - int widgetType = note.has(NoteColumns.WIDGET_TYPE) ? note + 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; + 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; + mOriginParent = originParent;//将该原始父文件夹ID覆盖原原始父文件夹ID - for (int i = 0; i < dataArray.length(); i++) { + for (int i = 0; i < dataArray.length(); i++) {//遍历 dataArray，查找 id 为 dataId 的数据 JSONObject data = dataArray.getJSONObject(i); SqlData sqlData = null; - if (data.has(DataColumns.ID)) { + if (data.has(DataColumns.ID)) {//该数据ID对应的数据如果存在，将对应的数据存在数据库中 long dataId = data.getLong(DataColumns.ID); for (SqlData temp : mDataList) { if (dataId == temp.getId()) { @@ -348,10 +348,10 @@ public class SqlNote { mDataList.add(sqlData); } - sqlData.setContent(data); + sqlData.setContent(data);//最后为数据库数据进行设置 } } - } catch (JSONException e) { + } catch (JSONException e) {//出现JSONException时，日志显示错误，同时打印堆栈轨迹 Log.e(TAG, e.toString()); e.printStackTrace(); return false; @@ -359,7 +359,7 @@ public class SqlNote { return true; } - public JSONObject getContent() { + public JSONObject getContent() {//获取content机制提供的数据并加载到note中 try { JSONObject js = new JSONObject(); @@ -368,7 +368,7 @@ public class SqlNote { return null; } - JSONObject note = new JSONObject(); + JSONObject note = new JSONObject();//新建变量note用于传输共享数据 if (mType == Notes.TYPE_NOTE) { note.put(NoteColumns.ID, mId); note.put(NoteColumns.ALERTED_DATE, mAlertDate); @@ -385,14 +385,14 @@ public class SqlNote { js.put(GTaskStringUtils.META_HEAD_NOTE, note); JSONArray dataArray = new JSONArray(); - for (SqlData sqlData : mDataList) { + 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) { + } 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); @@ -400,14 +400,14 @@ public class SqlNote { } return js; - } catch (JSONException e) { + } catch (JSONException e) {//捕获json类型异常，显示错误，打印堆栈痕迹 Log.e(TAG, e.toString()); e.printStackTrace(); } return null; } - public void setParentId(long id) { + public void setParentId(long id) {//给当前id设置父id mParentId = id; mDiffNoteValues.put(NoteColumns.PARENT_ID, id); } @@ -415,38 +415,38 @@ public class SqlNote { 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) { +//判断是否为便签类型 + 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 uri = mContentResolver.insert(Notes.CONTENT_NOTE_URI, mDiffNoteValues);//内容解析器中插入该便签的uri try { mId = Long.valueOf(uri.getPathSegments().get(1)); } catch (NumberFormatException e) { @@ -463,9 +463,9 @@ public class SqlNote { } } } else { - if (mId <= 0 && mId != Notes.ID_ROOT_FOLDER && mId != Notes.ID_CALL_RECORD_FOLDER) { + 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"); + throw new IllegalStateException("Try to update note with invalid id");//尝试以无效 id 更新 note } if (mDiffNoteValues.size() > 0) { mVersion ++; @@ -482,12 +482,12 @@ public class SqlNote { String.valueOf(mId), String.valueOf(mVersion) }); } - if (result == 0) { + if (result == 0) {//如果内容解析器没有更新，那么报错：没有更新，或许用户在同步时进行更新 Log.w(TAG, "there is no update. maybe user updates note when syncing"); } } - if (mType == Notes.TYPE_NOTE) { + if (mType == Notes.TYPE_NOTE) {//note 类型 for (SqlData sqlData : mDataList) { sqlData.commit(mId, validateVersion, mVersion); } @@ -495,11 +495,11 @@ public class SqlNote { } // refresh local info - loadFromCursor(mId); + loadFromCursor(mId);//通过 cursor 从当前 id 处加载数据 if (mType == Notes.TYPE_NOTE) loadDataContent(); mDiffNoteValues.clear(); - mIsCreate = false; + mIsCreate = false;//改变数据库构造模式 } } diff --git a/src/main/java/net/micode/notes/gtask/data/Task.java b/src/main/java/net/micode/notes/gtask/data/Task.java index 6a19454..b071b95 100644 --- a/src/main/java/net/micode/notes/gtask/data/Task.java +++ b/src/main/java/net/micode/notes/gtask/data/Task.java @@ -32,9 +32,9 @@ import org.json.JSONException; import org.json.JSONObject; -public class Task extends Node { +public class Task extends Node {//创建Task类（继承父类Node） private static final String TAG = Task.class.getSimpleName(); - +//调用 getSimpleName ()函数来得到类的简写名称并存入字符串TAG中 private boolean mCompleted; private String mNotes; @@ -45,16 +45,16 @@ public class Task extends Node { private TaskList mParent; - public Task() { + public Task() {//Task类的构造函数，对对象进行初始化 super(); - mCompleted = false; + mCompleted = false;//接下来是对类的变量进行初始化 mNotes = null; mPriorSibling = null; mParent = null; mMetaInfo = null; } - public JSONObject getCreateAction(int actionId) { + public JSONObject getCreateAction(int actionId) {//对操作号即actionId 进行一些操作的公用函数 JSONObject js = new JSONObject(); try { @@ -69,12 +69,12 @@ public class Task extends Node { js.put(GTaskStringUtils.GTASK_JSON_INDEX, mParent.getChildTaskIndex(this)); // entity_delta - JSONObject entity = new JSONObject(); + 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) { + if (getNotes() != null) {//如果存在 notes ，则将其也放入 entity 中 entity.put(GTaskStringUtils.GTASK_JSON_NOTES, getNotes()); } js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); @@ -94,7 +94,7 @@ public class Task extends Node { js.put(GTaskStringUtils.GTASK_JSON_PRIOR_SIBLING_ID, mPriorSibling.getGid()); } - } catch (JSONException e) { + } catch (JSONException e) {//抛出异常处理机制 Log.e(TAG, e.toString()); e.printStackTrace(); throw new ActionFailureException("fail to generate task-create jsonobject"); @@ -103,10 +103,10 @@ public class Task extends Node { return js; } - public JSONObject getUpdateAction(int actionId) { - JSONObject js = new JSONObject(); + public JSONObject getUpdateAction(int actionId) {//接收更新action + JSONObject js = new JSONObject();//声明并初始化 - try { + try {//同样是使用try和catch进行异常处理操作 // action_type js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); @@ -126,7 +126,7 @@ public class Task extends Node { entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); - } catch (JSONException e) { + } catch (JSONException e) {//获取异常类型和异常详细消息 Log.e(TAG, e.toString()); e.printStackTrace(); throw new ActionFailureException("fail to generate task-update jsonobject"); @@ -175,22 +175,22 @@ public class Task extends Node { } } - public void setContentByLocalJSON(JSONObject js) { + 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"); + Log.w(TAG, "setContentByLocalJSON: nothing is avaiable");//那么反馈给用户出错信息 } - try { + 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) { - Log.e(TAG, "invalid type"); + if (note.getInt(NoteColumns.TYPE) != Notes.TYPE_NOTE) {//note 类型匹配失败 + Log.e(TAG, "invalid type");//错误，无效类型 return; } - for (int i = 0; i < dataArray.length(); i++) { + 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)); @@ -204,7 +204,7 @@ public class Task extends Node { } } - public JSONObject getLocalJSONFromContent() { + public JSONObject getLocalJSONFromContent() {//从content获取本地json String name = getName(); try { if (mMetaInfo == null) { @@ -214,7 +214,7 @@ public class Task extends Node { return null; } - JSONObject js = new JSONObject(); + JSONObject js = new JSONObject();//初始化四个指针 JSONObject note = new JSONObject(); JSONArray dataArray = new JSONArray(); JSONObject data = new JSONObject(); @@ -224,12 +224,12 @@ public class Task extends Node { note.put(NoteColumns.TYPE, Notes.TYPE_NOTE); js.put(GTaskStringUtils.META_HEAD_NOTE, note); return js; - } else { + } 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++) { + 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()); @@ -247,8 +247,8 @@ public class Task extends Node { } } - public void setMetaInfo(MetaData metaData) { - if (metaData != null && metaData.getNotes() != null) { + public void setMetaInfo(MetaData metaData) {//设置元数据信息 + if (metaData != null && metaData.getNotes() != null) {//如果元数据存在且能够获取到文本信息 try { mMetaInfo = new JSONObject(metaData.getNotes()); } catch (JSONException e) { @@ -258,32 +258,32 @@ public class Task extends Node { } } - public int getSyncAction(Cursor c) { + public int getSyncAction(Cursor c) {//设置同步action try { JSONObject noteInfo = null; - if (mMetaInfo != null && mMetaInfo.has(GTaskStringUtils.META_HEAD_NOTE)) { + if (mMetaInfo != null && mMetaInfo.has(GTaskStringUtils.META_HEAD_NOTE)) {//代码块：元数据信息不为空并且元数据信息还含有“META_HEAD_NOTE”，说明便签存在 noteInfo = mMetaInfo.getJSONObject(GTaskStringUtils.META_HEAD_NOTE); } - if (noteInfo == null) { + 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)) { + 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)) { + 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) { + if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) {//判断有无同步 // there is no local update - if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) { + if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {//最近一次修改的 id 匹配成功，返回无的同步行为 // no update both side return SYNC_ACTION_NONE; } else { @@ -292,11 +292,11 @@ public class Task extends Node { } } else { // validate gtask id - if (!c.getString(SqlNote.GTASK_ID_COLUMN).equals(getGid())) { + 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()) { + if (c.getLong(SqlNote.SYNC_ID_COLUMN) == getLastModified()) {//本地id与云端id一致，即更新云端 // local modification only return SYNC_ACTION_UPDATE_REMOTE; } else { @@ -311,7 +311,7 @@ public class Task extends Node { return SYNC_ACTION_ERROR; } - public boolean isWorthSaving() { + public boolean isWorthSaving() {//可以保存的情况 return mMetaInfo != null || (getName() != null && getName().trim().length() > 0) || (getNotes() != null && getNotes().trim().length() > 0); } @@ -319,33 +319,33 @@ public class Task extends Node { 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/src/main/java/net/micode/notes/gtask/data/TaskList.java b/src/main/java/net/micode/notes/gtask/data/TaskList.java index 4ea21c5..e6e58d9 100644 --- a/src/main/java/net/micode/notes/gtask/data/TaskList.java +++ b/src/main/java/net/micode/notes/gtask/data/TaskList.java @@ -30,20 +30,20 @@ import org.json.JSONObject; import java.util.ArrayList; -public class TaskList extends Node { +public class TaskList extends Node {//创建继承 Node的任务表类 private static final String TAG = TaskList.class.getSimpleName(); - +//调用getSimplename（）函数获取名字并赋值给TAG作为标记 private int mIndex; - +//当前Tasklist的指针 private ArrayList mChildren; - - public TaskList() { +//类中主要的保存数据的单元，用来实现一个以Task为元素的ArrayList + public TaskList() {//TaskList 的构造函数 super(); mChildren = new ArrayList(); mIndex = 1; } - public JSONObject getCreateAction(int actionId) { + public JSONObject getCreateAction(int actionId) {//生成并返回一个包含了一定数据的JSONObject实体 JSONObject js = new JSONObject(); try { @@ -74,10 +74,11 @@ public class TaskList extends Node { return js; } - public JSONObject getUpdateAction(int actionId) { + public JSONObject getUpdateAction(int actionId) {//参考net.micode.notes.gtask.data.Node#getUpdateAction(int) + 生成并返回一个包含了一定数据的JSONObject实体 JSONObject js = new JSONObject(); - try { + try {//初始化 js 中的数据 // action_type js.put(GTaskStringUtils.GTASK_JSON_ACTION_TYPE, GTaskStringUtils.GTASK_JSON_ACTION_TYPE_UPDATE); @@ -94,34 +95,34 @@ public class TaskList extends Node { entity.put(GTaskStringUtils.GTASK_JSON_DELETED, getDeleted()); js.put(GTaskStringUtils.GTASK_JSON_ENTITY_DELTA, entity); - } catch (JSONException e) { + } catch (JSONException e) {//代码块：处理异常信息 Log.e(TAG, e.toString()); e.printStackTrace(); - throw new ActionFailureException("fail to generate tasklist-update jsonobject"); + throw new ActionFailureException("fail to generate tasklist-update jsonobject");//生成更新任务列表的 JSONObject 失败，抛出异常 } return js; } - public void setContentByRemoteJSON(JSONObject js) { - if (js != null) { + public void setContentByRemoteJSON(JSONObject js) {//通过云端 JSON 数据设置实例化对象 js 的内容 + if (js != null) {//判断js对象是否为空，如果为空即没有内容就不需要进行设置了 try { // id - if (js.has(GTaskStringUtils.GTASK_JSON_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)) { + 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)) { + if (js.has(GTaskStringUtils.GTASK_JSON_NAME)) {//语句块：对任务的name进行设置 setName(js.getString(GTaskStringUtils.GTASK_JSON_NAME)); } - } catch (JSONException e) { + } catch (JSONException e) {//代码块：处理异常 Log.e(TAG, e.toString()); e.printStackTrace(); throw new ActionFailureException("fail to get tasklist content from jsonobject"); @@ -129,14 +130,14 @@ public class TaskList extends Node { } } - public void setContentByLocalJSON(JSONObject js) { + 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); @@ -157,17 +158,17 @@ public class TaskList extends Node { } } - public JSONObject getLocalJSONFromContent() { + public JSONObject getLocalJSONFromContent() {//通过 Content 机制获取本地 JSON 数据 try { JSONObject js = new JSONObject(); JSONObject folder = new JSONObject(); String folderName = getName(); - if (getName().startsWith(GTaskStringUtils.MIUI_FOLDER_PREFFIX)) + 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) + if (folderName.equals(GTaskStringUtils.FOLDER_DEFAULT)//代码块：这里与上一个函数setContentByRemoteJSON(JSONObject js)是一个逆过程，可以参看上一个函数是如何构造出foldername的 || folderName.equals(GTaskStringUtils.FOLDER_CALL_NOTE)) folder.put(NoteColumns.TYPE, Notes.TYPE_SYSTEM); else @@ -183,7 +184,7 @@ public class TaskList extends Node { } } - public int getSyncAction(Cursor c) { + public int getSyncAction(Cursor c) {//通过 cursor 获取同步信息 try { if (c.getInt(SqlNote.LOCAL_MODIFIED_COLUMN) == 0) { // there is no local update @@ -208,7 +209,7 @@ public class TaskList extends Node { return SYNC_ACTION_UPDATE_REMOTE; } } - } catch (Exception e) { + } catch (Exception e) {//获取异常类型和异常详细消息 Log.e(TAG, e.toString()); e.printStackTrace(); } @@ -218,9 +219,9 @@ public class TaskList extends Node { public int getChildTaskCount() { return mChildren.size(); - } + }//获得TaskList的大小，即mChildren的大小，mChildren 是TaskList 的一个实例 - public boolean addChildTask(Task task) { + public boolean addChildTask(Task task) {//在当前任务表末尾添加新的任务。 boolean ret = false; if (task != null && !mChildren.contains(task)) { ret = mChildren.add(task); @@ -234,13 +235,13 @@ public class TaskList extends Node { return ret; } - public boolean addChildTask(Task task, int index) { - if (index < 0 || index > mChildren.size()) { + 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); + int pos = mChildren.indexOf(task);//获取要添加的任务在任务表中的位置 if (task != null && pos == -1) { mChildren.add(index, task); @@ -252,7 +253,7 @@ public class TaskList extends Node { if (index != mChildren.size() - 1) afterTask = mChildren.get(index + 1); - task.setPriorSibling(preTask); + task.setPriorSibling(preTask);//使得三个任务前后连在一块 if (afterTask != null) afterTask.setPriorSibling(task); } @@ -260,19 +261,19 @@ public class TaskList extends Node { return true; } - public boolean removeChildTask(Task task) { + public boolean removeChildTask(Task task) {//删除TaskList中的一个Task boolean ret = false; int index = mChildren.indexOf(task); if (index != -1) { ret = mChildren.remove(task); - if (ret) { + if (ret) {//如果删除成功，就要将该任务的优先兄弟任务和父任务设置为空 // reset prior sibling and parent task.setPriorSibling(null); task.setParent(null); // update the task list - if (index != mChildren.size()) { + if (index != mChildren.size()) {//代码块：删除成功后，要对任务列表进行更新 mChildren.get(index).setPriorSibling( index == 0 ? null : mChildren.get(index - 1)); } @@ -281,14 +282,14 @@ public class TaskList extends Node { return ret; } - public boolean moveChildTask(Task task, int index) { + public boolean moveChildTask(Task task, int index) {//将当前TaskList中含有的某个Task移到index位置 - if (index < 0 || index >= mChildren.size()) { + if (index < 0 || index >= mChildren.size()) {//代码块：首先判断移动的位置是不是合法的 Log.e(TAG, "move child task: invalid index"); return false; } - int pos = mChildren.indexOf(task); + int pos = mChildren.indexOf(task);//task不在列表中 if (pos == -1) { Log.e(TAG, "move child task: the task should in the list"); return false; @@ -299,7 +300,7 @@ public class TaskList extends Node { return (removeChildTask(task) && addChildTask(task, index)); } - public Task findChildTaskByGid(String gid) { + 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)) { @@ -311,16 +312,16 @@ public class TaskList extends Node { public int getChildTaskIndex(Task task) { return mChildren.indexOf(task); - } + }//返回指定Task的index - public Task getChildTaskByIndex(int 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)) @@ -331,13 +332,13 @@ public class TaskList extends Node { public ArrayList getChildTaskList() { return this.mChildren; - } + }//获取子任务列表 public void setIndex(int index) { this.mIndex = index; } - +//设置任务索引 public int getIndex() { return this.mIndex; } -} +}//获取任务索引 diff --git a/src/main/java/net/micode/notes/gtask/exception/ActionFailureException.java b/src/main/java/net/micode/notes/gtask/exception/ActionFailureException.java index 15504be..53bf37d 100644 --- a/src/main/java/net/micode/notes/gtask/exception/ActionFailureException.java +++ b/src/main/java/net/micode/notes/gtask/exception/ActionFailureException.java @@ -14,20 +14,21 @@ * limitations under the License. */ -package net.micode.notes.gtask.exception; +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/src/main/java/net/micode/notes/gtask/exception/NetworkFailureException.java b/src/main/java/net/micode/notes/gtask/exception/NetworkFailureException.java index b08cfb1..9913732 100644 --- a/src/main/java/net/micode/notes/gtask/exception/NetworkFailureException.java +++ b/src/main/java/net/micode/notes/gtask/exception/NetworkFailureException.java @@ -14,20 +14,21 @@ * limitations under the License. */ -package net.micode.notes.gtask.exception; +package net.micode.notes.gtask.exception;//小米便签网络异常处理 public class NetworkFailureException extends Exception { private static final long serialVersionUID = 2107610287180234136L; - +//serialVersionUID相当于java类的身份证。主要用于版本控制。 public NetworkFailureException() { super(); } - - public NetworkFailureException(String paramString) { +//不带参数的构造函数，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/src/main/java/net/micode/notes/gtask/remote/GTaskASyncTask.java b/src/main/java/net/micode/notes/gtask/remote/GTaskASyncTask.java index afc2fe1..fb3d284 100644 --- a/src/main/java/net/micode/notes/gtask/remote/GTaskASyncTask.java +++ b/src/main/java/net/micode/notes/gtask/remote/GTaskASyncTask.java @@ -28,23 +28,29 @@ 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; @@ -53,18 +59,22 @@ public class GTaskASyncTask extends AsyncTask { 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); @@ -87,6 +97,7 @@ public class GTaskASyncTask extends AsyncTask { } @Override + //异步执行后台线程将要完成的任务 protected Integer doInBackground(Void... unused) { publishProgess(mContext.getString(R.string.sync_progress_login, NotesPreferenceActivity .getSyncAccountName(mContext))); @@ -94,6 +105,7 @@ public class GTaskASyncTask extends AsyncTask { } @Override + //用于显示任务执行的进度 protected void onProgressUpdate(String... progress) { showNotification(R.string.ticker_syncing, progress[0]); if (mContext instanceof GTaskSyncService) { @@ -102,7 +114,9 @@ public class GTaskASyncTask extends AsyncTask { } @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())); @@ -118,6 +132,7 @@ public class GTaskASyncTask extends AsyncTask { if (mOnCompleteListener != null) { new Thread(new Runnable() { + //执行完后调用然后返回主线程中 public void run() { mOnCompleteListener.onComplete(); } diff --git a/src/main/java/net/micode/notes/gtask/remote/GTaskClient.java b/src/main/java/net/micode/notes/gtask/remote/GTaskClient.java index c67dfdf..1826e51 100644 --- a/src/main/java/net/micode/notes/gtask/remote/GTaskClient.java +++ b/src/main/java/net/micode/notes/gtask/remote/GTaskClient.java @@ -61,17 +61,24 @@ 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; @@ -90,6 +97,7 @@ public class GTaskClient { private JSONArray mUpdateArray; + //GTaskClient的构造函数 private GTaskClient() { mHttpClient = null; mGetUrl = GTASK_GET_URL; @@ -102,6 +110,7 @@ public class GTaskClient { mUpdateArray = null; } + //获取实例，如果当前没有示例，则新建一个登陆的Gtask，如果有直接返回 public static synchronized GTaskClient getInstance() { if (mInstance == null) { mInstance = new GTaskClient(); @@ -109,6 +118,7 @@ public class GTaskClient { return mInstance; } + //用来实现登录操作的函数 public boolean login(Activity activity) { // we suppose that the cookie would expire after 5 minutes // then we need to re-login @@ -164,6 +174,7 @@ public class GTaskClient { return true; } + //用以具体实现登录Google账号的方法，方法返回账号令牌 private String loginGoogleAccount(Activity activity, boolean invalidateToken) { String authToken; AccountManager accountManager = AccountManager.get(activity); @@ -207,6 +218,7 @@ public class GTaskClient { 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 @@ -225,6 +237,7 @@ public class GTaskClient { return true; } + //实现登录Gtask方法的函数 private boolean loginGtask(String authToken) { int timeoutConnection = 10000; int timeoutSocket = 15000; @@ -280,10 +293,12 @@ public class GTaskClient { 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"); @@ -291,6 +306,7 @@ public class GTaskClient { return httpPost; } + //通过URL获取响应后返回的数据，使用getContentEncoding()获取网络上的资源和数据，返回值就是获取到的资源 private String getResponseContent(HttpEntity entity) throws IOException { String contentEncoding = null; if (entity.getContentEncoding() != null) { @@ -323,6 +339,7 @@ public class GTaskClient { } } + //通过JSON发送请求,利用UrlEncodedFormEntity entity和httpPost.setEntity把js中的内容放置到httpPost中后将资源再次放入json后返回 private JSONObject postRequest(JSONObject js) throws NetworkFailureException { if (!mLoggedin) { Log.e(TAG, "please login first"); @@ -360,6 +377,7 @@ public class GTaskClient { } } + //创建单个任务，通过json获取TASK中的内容并创建对应的jsPost，使用setGid方法设置task的new_id public void createTask(Task task) throws NetworkFailureException { commitUpdate(); try { @@ -386,6 +404,7 @@ public class GTaskClient { } } + //创建任务列表 public void createTaskList(TaskList tasklist) throws NetworkFailureException { commitUpdate(); try { @@ -412,6 +431,7 @@ public class GTaskClient { } } + //利用JSON提交更新数据 public void commitUpdate() throws NetworkFailureException { if (mUpdateArray != null) { try { @@ -433,6 +453,7 @@ public class GTaskClient { } } + //利用commitUpdate添加更新节点 public void addUpdateNode(Node node) throws NetworkFailureException { if (node != null) { // too many update items may result in an error @@ -447,6 +468,7 @@ public class GTaskClient { } } + //移动任务 public void moveTask(Task task, TaskList preParent, TaskList curParent) throws NetworkFailureException { commitUpdate(); @@ -486,6 +508,7 @@ public class GTaskClient { } } + //删除操作节点 public void deleteNode(Node node) throws NetworkFailureException { commitUpdate(); try { @@ -509,6 +532,7 @@ public class GTaskClient { } } + //获取任务列表，首先通过getURI在网上获取数据，在截取所需部分内容返回 public JSONArray getTaskLists() throws NetworkFailureException { if (!mLoggedin) { Log.e(TAG, "please login first"); @@ -547,6 +571,7 @@ public class GTaskClient { } } + //获取任务列表 public JSONArray getTaskList(String listGid) throws NetworkFailureException { commitUpdate(); try { @@ -575,10 +600,12 @@ public class GTaskClient { } } + //获得同步账户 public Account getSyncAccount() { return mAccount; } + //重置更新内容 public void resetUpdateArray() { mUpdateArray = null; } diff --git a/src/main/java/net/micode/notes/gtask/remote/GTaskManager.java b/src/main/java/net/micode/notes/gtask/remote/GTaskManager.java index d2b4082..2de2547 100644 --- a/src/main/java/net/micode/notes/gtask/remote/GTaskManager.java +++ b/src/main/java/net/micode/notes/gtask/remote/GTaskManager.java @@ -47,10 +47,12 @@ 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; @@ -61,6 +63,7 @@ public class GTaskManager { public static final int STATE_SYNC_CANCELLED = 4; + // private 定义一系列不可被外部的类访问的量 private static GTaskManager mInstance = null; private Activity mActivity; @@ -87,6 +90,7 @@ public class GTaskManager { private HashMap mNidToGid; + //该类的构造函数 private GTaskManager() { mSyncing = false; mCancelled = false; @@ -99,6 +103,7 @@ public class GTaskManager { mNidToGid = new HashMap(); } + //获取一个实例，通过GTaskManager()新建一个mInstance public static synchronized GTaskManager getInstance() { if (mInstance == null) { mInstance = new GTaskManager(); @@ -106,20 +111,25 @@ public class 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(); @@ -132,6 +142,7 @@ public class GTaskManager { client.resetUpdateArray(); // login google task + //登录谷歌账号 if (!mCancelled) { if (!client.login(mActivity)) { throw new NetworkFailureException("login google task failed"); @@ -139,10 +150,12 @@ public class GTaskManager { } // 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) { @@ -168,6 +181,7 @@ public class GTaskManager { return mCancelled ? STATE_SYNC_CANCELLED : STATE_SUCCESS; } + //初始化GTask列表，将google上的JSONTaskList转为本地任务列表 private void initGTaskList() throws NetworkFailureException { if (mCancelled) return; @@ -247,6 +261,7 @@ public class GTaskManager { } } + //选择同步操作的类型并做好相应准备 具体做法是对每一种情况都把所有的任务判断一次，一旦发现是该种情况，就立即执行任务，否则判断下个任务 private void syncContent() throws NetworkFailureException { int syncType; Cursor c = null; @@ -260,6 +275,7 @@ public class GTaskManager { } // for local deleted note + //处理本地删除的note try { c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(type<>? AND parent_id=?)", new String[] { @@ -290,6 +306,7 @@ public class GTaskManager { syncFolder(); // for note existing in database + //对已经存在与数据库的节点进行同步 try { c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(type=? AND parent_id<>?)", new String[] { @@ -327,6 +344,7 @@ public class GTaskManager { } // go through remaining items + //访问保留的项目 Iterator> iter = mGTaskHashMap.entrySet().iterator(); while (iter.hasNext()) { Map.Entry entry = iter.next(); @@ -337,6 +355,7 @@ public class GTaskManager { // 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"); @@ -351,6 +370,7 @@ public class GTaskManager { } + //对文件夹进行同步，具体操作与之前的同步操作一致 private void syncFolder() throws NetworkFailureException { Cursor c = null; String gid; @@ -362,6 +382,7 @@ public class GTaskManager { } // for root folder + //同步根目录 try { c = mContentResolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, Notes.ID_ROOT_FOLDER), SqlNote.PROJECTION_NOTE, null, null, null); @@ -391,6 +412,7 @@ public class GTaskManager { } // for call-note folder + //同步来电记录的文件夹 try { c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(_id=?)", new String[] { @@ -425,6 +447,7 @@ public class GTaskManager { } // for local existing folders + //同步已经存在的文件夹 try { c = mContentResolver.query(Notes.CONTENT_NOTE_URI, SqlNote.PROJECTION_NOTE, "(type=? AND parent_id<>?)", new String[] { @@ -461,6 +484,7 @@ public class GTaskManager { } // for remote add folders + //同步远程添加的文件夹 Iterator> iter = mGTaskListHashMap.entrySet().iterator(); while (iter.hasNext()) { Map.Entry entry = iter.next(); @@ -476,6 +500,7 @@ public class GTaskManager { GTaskClient.getInstance().commitUpdate(); } + //在之前对于各方面的同步操作中多次调用了这个函数，作用是依据不同的同步类型去调用不同的函数，以达到本地与远程同步的实际操作 private void doContentSync(int syncType, Node node, Cursor c) throws NetworkFailureException { if (mCancelled) { return; @@ -522,12 +547,14 @@ public class GTaskManager { } } + //增加本地节点的操作，传入参量为待增添的节点 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)) { @@ -555,6 +582,7 @@ public class GTaskManager { } } + //以下为判断便签中的数据条目 if (js.has(GTaskStringUtils.META_HEAD_DATA)) { JSONArray dataArray = js.getJSONArray(GTaskStringUtils.META_HEAD_DATA); for (int i = 0; i < dataArray.length(); i++) { @@ -585,17 +613,21 @@ public class GTaskManager { } // 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; @@ -616,9 +648,11 @@ public class GTaskManager { 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; @@ -628,6 +662,7 @@ public class GTaskManager { Node n; // update remotely + // 如果sqlNote是节点类型，则设置好它的参数以及更新哈希表，再把节点更新到远程数据里 if (sqlNote.isNoteType()) { Task task = new Task(); task.setContentByLocalJSON(sqlNote.getContent()); @@ -648,6 +683,7 @@ public class GTaskManager { 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; @@ -672,6 +708,7 @@ public class GTaskManager { } // no match we can add now + //若没有匹配的任务列表，则创建一个新的任务列表 if (tasklist == null) { tasklist = new TaskList(); tasklist.setContentByLocalJSON(sqlNote.getContent()); @@ -682,16 +719,19 @@ public class GTaskManager { } // 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; @@ -700,13 +740,16 @@ public class GTaskManager { 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(); @@ -726,10 +769,12 @@ public class GTaskManager { } // 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); @@ -746,6 +791,7 @@ public class GTaskManager { } } + //刷新本地便签ID，从远程同步 private void refreshLocalSyncId() throws NetworkFailureException { if (mCancelled) { return; @@ -758,6 +804,10 @@ public class GTaskManager { 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[] { @@ -790,10 +840,12 @@ public class GTaskManager { } } + //string类化getSyncAccount() public String getSyncAccount() { return GTaskClient.getInstance().getSyncAccount().name; } + //取消同步，置mCancelled为true public void cancelSync() { mCancelled = true; } diff --git a/src/main/java/net/micode/notes/gtask/remote/GTaskSyncService.java b/src/main/java/net/micode/notes/gtask/remote/GTaskSyncService.java index cca36f7..4af3e5e 100644 --- a/src/main/java/net/micode/notes/gtask/remote/GTaskSyncService.java +++ b/src/main/java/net/micode/notes/gtask/remote/GTaskSyncService.java @@ -23,26 +23,34 @@ 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() { @@ -56,20 +64,25 @@ public class GTaskSyncService extends Service { } } + //取消同步 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: @@ -87,16 +100,19 @@ public class GTaskSyncService extends Service { } @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); @@ -105,6 +121,7 @@ public class GTaskSyncService extends Service { sendBroadcast(intent); } + //对变量activity事件进行同步操作 public static void startSync(Activity activity) { GTaskManager.getInstance().setActivityContext(activity); Intent intent = new Intent(activity, GTaskSyncService.class); @@ -112,16 +129,19 @@ public class GTaskSyncService extends Service { 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/src/main/java/net/micode/notes/model/Note.java b/src/main/java/net/micode/notes/model/Note.java index 6706cf6..975b9e5 100644 --- a/src/main/java/net/micode/notes/model/Note.java +++ b/src/main/java/net/micode/notes/model/Note.java @@ -35,24 +35,24 @@ import java.util.ArrayList; public class Note { - private ContentValues mNoteDiffValues; + 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 + // Create a new note in the database//获取新建便签的编号 ContentValues values = new ContentValues(); - long createdTime = System.currentTimeMillis(); + 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); - - long noteId = 0; +//外部应用对ContentProvider中的数据进行添加、删除、修改和查询操作 + long noteId = 0;//实现外部应用对数据的插入删除等操作 try { noteId = Long.valueOf(uri.getPathSegments().get(1)); } catch (NumberFormatException e) { @@ -65,12 +65,12 @@ public class Note { return noteId; } - public Note() { + public Note() {//定义两个变量用来存储便签的数据，一个是存储便签属性、一个是存储便签内容 mNoteDiffValues = new ContentValues(); mNoteData = new NoteData(); } - public void setNoteValue(String key, String value) { + public void setNoteValue(String key, String value) {//设置数据库表格的标签属性数据 mNoteDiffValues.put(key, value); mNoteDiffValues.put(NoteColumns.LOCAL_MODIFIED, 1); mNoteDiffValues.put(NoteColumns.MODIFIED_DATE, System.currentTimeMillis()); @@ -79,33 +79,33 @@ public class Note { 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); } - - public boolean isLocalModified() { +//得到电话号码数据的ID + public boolean isLocalModified() {//判断是否是本地修改 return mNoteDiffValues.size() > 0 || mNoteData.isLocalModified(); } - public boolean syncNote(Context context, long noteId) { + public boolean syncNote(Context context, long noteId) {//判断便签是否同步 if (noteId <= 0) { throw new IllegalArgumentException("Wrong note id:" + noteId); } - if (!isLocalModified()) { + if (!isLocalModified()) {//如果本地没有发现修改，直接返回1，指示已经同步到数据库中 return true; } @@ -114,15 +114,15 @@ public class Note { * {@link NoteColumns#MODIFIED_DATE}. For data safety, though update note fails, we also update the * note data info */ - if (context.getContentResolver().update( + 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(); + mNoteDiffValues.clear();//初始化便签特征值 - if (mNoteData.isLocalModified() + if (mNoteData.isLocalModified()//判断未同步 && (mNoteData.pushIntoContentResolver(context, noteId) == null)) { return false; } @@ -130,7 +130,7 @@ public class Note { return true; } - private class NoteData { + private class NoteData {//定义一个基本的便签内容的数据类，主要包含文本数据和电话号码数据 private long mTextDataId; private ContentValues mTextDataValues; @@ -141,14 +141,14 @@ public class Note { private static final String TAG = "NoteData"; - public NoteData() { + public NoteData() {//NoteData的构造函数，初始化四个变量 mTextDataValues = new ContentValues(); mCallDataValues = new ContentValues(); mTextDataId = 0; mCallDataId = 0; } - boolean isLocalModified() { + boolean isLocalModified() {//下面是上述几个函数的具体实现 return mTextDataValues.size() > 0 || mCallDataValues.size() > 0; } @@ -159,26 +159,26 @@ public class Note { mTextDataId = id; } - void setCallDataId(long 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) { + 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) { + 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 pushIntoContentResolver(Context context, long noteId) {//下面函数的作用是将新的数据通过Uri的操作存储到数据库 /** * Check for safety */ @@ -186,24 +186,24 @@ public class Note { throw new IllegalArgumentException("Wrong note id:" + noteId); } - ArrayList operationList = new ArrayList(); + ArrayList operationList = new ArrayList();//数据库操作链表 ContentProviderOperation.Builder builder = null; - if(mTextDataValues.size() > 0) { + if(mTextDataValues.size() > 0) {//把文本数据存入DataColumns mTextDataValues.put(DataColumns.NOTE_ID, noteId); - if (mTextDataId == 0) { + 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))); + setTextDataId(Long.valueOf(uri.getPathSegments().get(1)));//尝试重新给它设置id } catch (NumberFormatException e) { - Log.e(TAG, "Insert new text data fail with noteId" + noteId); + Log.e(TAG, "Insert new text data fail with noteId" + noteId);//插入数据失败 mTextDataValues.clear(); return null; } } else { - builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId( + builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId(//更新builder对象，追加uri数据和文本ID Notes.CONTENT_DATA_URI, mTextDataId)); builder.withValues(mTextDataValues); operationList.add(builder.build()); @@ -211,20 +211,20 @@ public class Note { mTextDataValues.clear(); } - if(mCallDataValues.size() > 0) { + if(mCallDataValues.size() > 0) {//对于电话号码的数据也是和文本数据一样的同步处理 mCallDataValues.put(DataColumns.NOTE_ID, noteId); - if (mCallDataId == 0) { + 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 { + 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 { + } else {// 当电话号码不为新建时，更新电话号码ID builder = ContentProviderOperation.newUpdate(ContentUris.withAppendedId( Notes.CONTENT_DATA_URI, mCallDataId)); builder.withValues(mCallDataValues); @@ -232,18 +232,18 @@ public class Note { } mCallDataValues.clear(); } - - if (operationList.size() > 0) { +//把电话号码数据存入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) { + } 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())); + Log.e(TAG, String.format("%s: %s", e.toString(), e.getMessage()));//异常日志 return null; } } diff --git a/src/main/java/net/micode/notes/model/WorkingNote.java b/src/main/java/net/micode/notes/model/WorkingNote.java index be081e4..3e06929 100644 --- a/src/main/java/net/micode/notes/model/WorkingNote.java +++ b/src/main/java/net/micode/notes/model/WorkingNote.java @@ -32,6 +32,7 @@ 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; @@ -62,6 +63,7 @@ public class WorkingNote { private NoteSettingChangedListener mNoteSettingStatusListener; + //声明 NOTE_PROJECTION字符串数组 public static final String[] DATA_PROJECTION = new String[] { DataColumns.ID, DataColumns.CONTENT, @@ -102,6 +104,7 @@ public class WorkingNote { private static final int NOTE_MODIFIED_DATE_COLUMN = 5; // New note construct + //缺省noteID的构造函数，直接使用内容和文件号新建便签 private WorkingNote(Context context, long folderId) { mContext = context; mAlertDate = 0; @@ -115,6 +118,7 @@ public class WorkingNote { } // Existing note construct + //加载便签 private WorkingNote(Context context, long noteId, long folderId) { mContext = context; mNoteId = noteId; @@ -124,6 +128,7 @@ public class WorkingNote { loadNote(); } + //输出mNoteId的所有属性值 private void loadNote() { Cursor cursor = mContext.getContentResolver().query( ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, mNoteId), NOTE_PROJECTION, null, @@ -146,6 +151,7 @@ public class WorkingNote { loadNoteData(); } + //加载便签数据 private void loadNoteData() { Cursor cursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI, DATA_PROJECTION, DataColumns.NOTE_ID + "=?", new String[] { @@ -174,6 +180,7 @@ public class WorkingNote { } } + //创建空的Note，传参：context，文件夹id，widget，背景颜色 public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId, int widgetType, int defaultBgColorId) { WorkingNote note = new WorkingNote(context, folderId); @@ -183,12 +190,16 @@ public class WorkingNote { 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); @@ -201,6 +212,7 @@ public class WorkingNote { /** * Update widget content if there exist any widget of this note */ + //判断窗口大小是否变化，如果变化也要保存这个变化 if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID && mWidgetType != Notes.TYPE_WIDGET_INVALIDE && mNoteSettingStatusListener != null) { @@ -212,11 +224,14 @@ public class WorkingNote { } } + //判断便签是否已经存在于数据库中 public boolean existInDatabase() { return mNoteId > 0; } + //判断是否有保存的必要性 private boolean isWorthSaving() { + //如果是误删，或者是空的，或者在本地并没有修改，那么不需要保存 if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent)) || (existInDatabase() && !mNote.isLocalModified())) { return false; @@ -225,11 +240,14 @@ public class WorkingNote { } } + //设置监听“设置状态改变” 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)); @@ -239,6 +257,7 @@ public class WorkingNote { } } + //设定删除标记 public void markDeleted(boolean mark) { mIsDeleted = mark; if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID @@ -247,9 +266,11 @@ public class WorkingNote { } } + //设置背景颜色为第ID号颜色 public void setBgColorId(int id) { if (id != mBgColorId) { mBgColorId = id; + //判断此id是否是背景颜色id，如果不是，则更新背景颜色 if (mNoteSettingStatusListener != null) { mNoteSettingStatusListener.onBackgroundColorChanged(); } @@ -257,7 +278,9 @@ public class WorkingNote { } } + //设定检查列表模式 public void setCheckListMode(int mode) { + //如果传入的模式与原模式不同，则更改原模式为当前模式 if (mMode != mode) { if (mNoteSettingStatusListener != null) { mNoteSettingStatusListener.onCheckListModeChanged(mMode, mode); @@ -267,81 +290,101 @@ public class WorkingNote { } } + //设置窗口类型 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 diff --git a/src/main/java/net/micode/notes/tool/BackupUtils.java b/src/main/java/net/micode/notes/tool/BackupUtils.java index 39f6ec4..1a46d58 100644 --- a/src/main/java/net/micode/notes/tool/BackupUtils.java +++ b/src/main/java/net/micode/notes/tool/BackupUtils.java @@ -35,13 +35,14 @@ import java.io.FileOutputStream; import java.io.IOException; import java.io.PrintStream; - +/*备份工具类，用于数据备份读取和显示*/ public class BackupUtils { - private static final String TAG = "BackupUtils"; + private static final String TAG = "BackupUtils";//定义类的名字标识 // Singleton stuff - private static BackupUtils sInstance; + private static BackupUtils sInstance;//定义实体对象 public static synchronized BackupUtils getInstance(Context context) { + //获取实体对象 if (sInstance == null) { sInstance = new BackupUtils(context); } @@ -49,56 +50,57 @@ public class BackupUtils { } /** - * Following states are signs to represents backup or restore - * status + * Following states are signs to represents backup or restore（以下是表示备份或恢复的符号） + * status（状态） */ - // Currently, the sdcard is not mounted + // Currently, the sdcard is not mounted（当前sd卡未安装） public static final int STATE_SD_CARD_UNMOUONTED = 0; - // The backup file not exist + // 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 + // 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 + // Some run-time exception which causes restore or backup fails（导致备份或还原失败的默写运行异常） public static final int STATE_SYSTEM_ERROR = 3; - // Backup or restore success + // Backup or restore success（备份或还原成功） public static final int STATE_SUCCESS = 4; - private TextExport mTextExport; - + 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, @@ -107,40 +109,44 @@ public class BackupUtils { 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; + 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 + * Export the folder identified by folder id to text（通过文件夹id向文本输出文件夹） */ private void exportFolderToText(String folderId, PrintStream ps) { - // Query notes belong to this folder + // Query notes belong to this folder（查询该notes是否属于这个文件夹） Cursor notesCursor = mContext.getContentResolver().query(Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, NoteColumns.PARENT_ID + "=?", new String[] { folderId @@ -149,21 +155,21 @@ public class BackupUtils { if (notesCursor != null) { if (notesCursor.moveToFirst()) { do { - // Print note's last modified date + // 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 + // Query data belong to this note（查询该note的数据） String noteId = notesCursor.getString(NOTE_COLUMN_ID); exportNoteToText(noteId, ps); - } while (notesCursor.moveToNext()); + } while (notesCursor.moveToNext());//对该note所有的数据 } - notesCursor.close(); + notesCursor.close();//关闭游标 } } /** - * Export note identified by id to a print stream + * 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, @@ -176,7 +182,7 @@ public class BackupUtils { do { String mimeType = dataCursor.getString(DATA_COLUMN_MIME_TYPE); if (DataConstants.CALL_NOTE.equals(mimeType)) { - // Print phone number + // 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); @@ -185,11 +191,11 @@ public class BackupUtils { ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), phoneNumber)); } - // Print call date + // 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 + // Print call attachment location（打印位置） if (!TextUtils.isEmpty(location)) { ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), location)); @@ -201,35 +207,35 @@ public class BackupUtils { content)); } } - } while (dataCursor.moveToNext()); + } while (dataCursor.moveToNext());//对所有数据 } - dataCursor.close(); + dataCursor.close();//关闭游标 } - // print a line separator between note + // 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()); + Log.e(TAG, e.toString());//错误报告 } } /** - * Note will be exported as text which is user readable + * 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; + return STATE_SD_CARD_UNMOUONTED;//sd卡未安装 } PrintStream ps = getExportToTextPrintStream(); if (ps == null) { Log.e(TAG, "get print stream error"); - return STATE_SYSTEM_ERROR; + return STATE_SYSTEM_ERROR;//系统状态错误 } - // First export folder and its notes + // First export folder and its notes（第一次输出文件夹和他的note） Cursor folderCursor = mContext.getContentResolver().query( Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, @@ -240,7 +246,7 @@ public class BackupUtils { if (folderCursor != null) { if (folderCursor.moveToFirst()) { do { - // Print folder's name + // 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); @@ -252,12 +258,12 @@ public class BackupUtils { } String folderId = folderCursor.getString(NOTE_COLUMN_ID); exportFolderToText(folderId, ps); - } while (folderCursor.moveToNext()); + } while (folderCursor.moveToNext());//对所有文件夹 } - folderCursor.close(); + folderCursor.close();//关闭游标 } - // Export notes in root's folder + // Export notes in root's folder（输出notes到系统文件夹） Cursor noteCursor = mContext.getContentResolver().query( Notes.CONTENT_NOTE_URI, NOTE_PROJECTION, @@ -270,7 +276,7 @@ public class BackupUtils { 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 + // Query data belong to this note（查询这个note的数据） String noteId = noteCursor.getString(NOTE_COLUMN_ID); exportNoteToText(noteId, ps); } while (noteCursor.moveToNext()); @@ -286,18 +292,19 @@ public class BackupUtils { * 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"); + Log.e(TAG, "create file to exported failed");//异常报告 return null; } - mFileName = file.getName(); - mFileDirectory = mContext.getString(R.string.file_path); + mFileName = file.getName();//文件名字 + mFileDirectory = mContext.getString(R.string.file_path);//文件路径 PrintStream ps = null; try { FileOutputStream fos = new FileOutputStream(file); - ps = new PrintStream(fos); + ps = new PrintStream(fos);//创建一个打印流指向这个创建的文件 } catch (FileNotFoundException e) { e.printStackTrace(); return null; @@ -305,36 +312,37 @@ public class BackupUtils { e.printStackTrace(); return null; } - return ps; + return ps;//返回新文件的打印流 } } /** - * Generate the text file to store imported data + * 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()); - sb.append(context.getString(filePathResId)); - File filedir = new File(sb.toString()); + 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()); + System.currentTimeMillis())));//将当前的系统时间以预定的格式输出 + File file = new File(sb.toString());//将输出连接到一个文件里 try { if (!filedir.exists()) { - filedir.mkdir(); + filedir.mkdir();//创建新文件夹 } if (!file.exists()) { - file.createNewFile(); + file.createNewFile();//创建新文件 } return file; } catch (SecurityException e) { - e.printStackTrace(); + e.printStackTrace();//错误抛出异常 } catch (IOException e) { - e.printStackTrace(); + e.printStackTrace();////错误抛出异常 } return null; diff --git a/src/main/java/net/micode/notes/tool/DataUtils.java b/src/main/java/net/micode/notes/tool/DataUtils.java index 2a14982..831bb1f 100644 --- a/src/main/java/net/micode/notes/tool/DataUtils.java +++ b/src/main/java/net/micode/notes/tool/DataUtils.java @@ -34,52 +34,55 @@ 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 final String TAG = "DataUtils";//定义该自定义类标识 public static boolean batchDeleteNotes(ContentResolver resolver, HashSet ids) { + //处理批量删除便签的方法 if (ids == null) { - Log.d(TAG, "the ids is 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"); + 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"); + 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()); + 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())); + 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())); + 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(); - values.put(NoteColumns.PARENT_ID, desFolderId); - values.put(NoteColumns.ORIGIN_PARENT_ID, srcFolderId); - values.put(NoteColumns.LOCAL_MODIFIED, 1); - resolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id), values, null, null); + 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) { @@ -97,6 +100,7 @@ public class DataUtils { } 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()); @@ -112,14 +116,14 @@ public class DataUtils { } /** - * Get the all folder count except system folders {@link Notes#TYPE_SYSTEM}} + * 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); + null);//在数据库中查询并用游标指向它 int count = 0; if(cursor != null) { @@ -127,82 +131,87 @@ public class DataUtils { try { count = cursor.getInt(0); } catch (IndexOutOfBoundsException e) { - Log.e(TAG, "get folder count failed:" + e.toString()); + Log.e(TAG, "get folder count failed:" + e.toString());//失败报告 } finally { cursor.close(); } } } - return count; + 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); + null);//查询note是否可以找到 boolean exist = false; if (cursor != null) { if (cursor.getCount() > 0) { - exist = true; + exist = true;//找到 } cursor.close(); } - return exist; + 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); + null, null, null, null);//查询数据是否存在 boolean exist = false; if (cursor != null) { if (cursor.getCount() > 0) { - exist = true; + exist = true;///找到 } cursor.close(); } - return exist; + 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); + null, null, null, null);//查找数据 boolean exist = false; if (cursor != null) { if (cursor.getCount() > 0) { - exist = true; + exist = true;//找到 } cursor.close(); } - return exist; + 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); + new String[] { name }, null);//查询 boolean exist = false; if(cursor != null) { if(cursor.getCount() > 0) { - exist = true; + exist = true;//找到 } cursor.close(); } - return exist; + 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); + null);//父ID是否为传入的folderId HashSet set = null; if (c != null) { @@ -213,7 +222,7 @@ public class DataUtils { AppWidgetAttribute widget = new AppWidgetAttribute(); widget.widgetId = c.getInt(0); widget.widgetType = c.getInt(1); - set.add(widget); + set.add(widget);//存储不同窗口的id和type } catch (IndexOutOfBoundsException e) { Log.e(TAG, e.toString()); } @@ -225,17 +234,18 @@ public class DataUtils { } 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); + null);//在数据库查询 if (cursor != null && cursor.moveToFirst()) { try { - return cursor.getString(0); + return cursor.getString(0);//找到 } catch (IndexOutOfBoundsException e) { - Log.e(TAG, "Get call number fails " + e.toString()); + Log.e(TAG, "Get call number fails " + e.toString());//没找到 } finally { cursor.close(); } @@ -244,45 +254,48 @@ public class DataUtils { } 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); + null);//在数据库查询 if (cursor != null) { if (cursor.moveToFirst()) { try { - return cursor.getLong(0); + return cursor.getLong(0);//找到 } catch (IndexOutOfBoundsException e) { - Log.e(TAG, "Get call note id fails " + e.toString()); + Log.e(TAG, "Get call note id fails " + e.toString());//失败 } } - cursor.close(); + 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); + null);//查找 if (cursor != null) { String snippet = ""; if (cursor.moveToFirst()) { - snippet = cursor.getString(0); + snippet = cursor.getString(0);//找到 } - cursor.close(); + cursor.close();//关闭游标 return snippet; } - throw new IllegalArgumentException("Note is not found with id: " + noteId); + 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'); diff --git a/src/main/java/net/micode/notes/tool/GTaskStringUtils.java b/src/main/java/net/micode/notes/tool/GTaskStringUtils.java index 666b729..cd4c10b 100644 --- a/src/main/java/net/micode/notes/tool/GTaskStringUtils.java +++ b/src/main/java/net/micode/notes/tool/GTaskStringUtils.java @@ -15,36 +15,36 @@ */ package net.micode.notes.tool; - +/*定义了很多的静态常量字符串，目的就是为了提供jsonObject中相应字符串的"key"。把这些静态的定义单独写到了一个类里面，方便查找和更改*/ public class GTaskStringUtils { - public final static String GTASK_JSON_ACTION_ID = "action_id"; + 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_LIST = "action_list";//任务列表 - public final static String GTASK_JSON_ACTION_TYPE = "action_type"; + 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_CREATE = "create";//新建 - public final static String GTASK_JSON_ACTION_TYPE_GETALL = "get_all"; + 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_MOVE = "move";//移动 - public final static String GTASK_JSON_ACTION_TYPE_UPDATE = "update"; + public final static String GTASK_JSON_ACTION_TYPE_UPDATE = "update";//更新 - public final static String GTASK_JSON_CREATOR_ID = "creator_id"; + 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_CHILD_ENTITY = "child_entity";//子实体 - public final static String GTASK_JSON_CLIENT_VERSION = "client_version"; + public final static String GTASK_JSON_CLIENT_VERSION = "client_version";//客户端 - public final static String GTASK_JSON_COMPLETED = "completed"; + public final static String GTASK_JSON_COMPLETED = "completed";//完成 - public final static String GTASK_JSON_CURRENT_LIST_ID = "current_list_id"; + 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"; + 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_DELETED = "deleted";//删除 public final static String GTASK_JSON_DEST_LIST = "dest_list"; @@ -58,47 +58,47 @@ public class GTaskStringUtils { public final static String GTASK_JSON_GET_DELETED = "get_deleted"; - public final static String GTASK_JSON_ID = "id"; + public final static String GTASK_JSON_ID = "id";//id - public final static String GTASK_JSON_INDEX = "index"; + public final static String GTASK_JSON_INDEX = "index";//索引 - public final static String GTASK_JSON_LAST_MODIFIED = "last_modified"; + 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_LATEST_SYNC_POINT = "latest_sync_point";//最后一次同步 - public final static String GTASK_JSON_LIST_ID = "list_id"; + 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_LISTS = "lists";//列表 - public final static String GTASK_JSON_NAME = "name"; + public final static String GTASK_JSON_NAME = "name";//名字 - public final static String GTASK_JSON_NEW_ID = "new_id"; + 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_NOTES = "notes";//便签 - public final static String GTASK_JSON_PARENT_ID = "parent_id"; + 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_RESULTS = "results";//结果 - public final static String GTASK_JSON_SOURCE_LIST = "source_list"; + public final static String GTASK_JSON_SOURCE_LIST = "source_list";//源列表 - public final static String GTASK_JSON_TASKS = "tasks"; + public final static String GTASK_JSON_TASKS = "tasks";//任务 - public final static String GTASK_JSON_TYPE = "type"; + public final static String GTASK_JSON_TYPE = "type";//类型 - public final static String GTASK_JSON_TYPE_GROUP = "GROUP"; + public final static String GTASK_JSON_TYPE_GROUP = "GROUP";//组类型 - public final static String GTASK_JSON_TYPE_TASK = "TASK"; + public final static String GTASK_JSON_TYPE_TASK = "TASK";//任务类型 - public final static String GTASK_JSON_USER = "user"; + public final static String GTASK_JSON_USER = "user";//使用者 - public final static String MIUI_FOLDER_PREFFIX = "[MIUI_Notes]"; + public final static String MIUI_FOLDER_PREFFIX = "[MIUI_Notes]";//小米便签 - public final static String FOLDER_DEFAULT = "Default"; + public final static String FOLDER_DEFAULT = "Default";//默认 - public final static String FOLDER_CALL_NOTE = "Call_Note"; + public final static String FOLDER_CALL_NOTE = "Call_Note";//呼叫标签 public final static String FOLDER_META = "METADATA"; diff --git a/src/main/java/net/micode/notes/tool/ResourceParser.java b/src/main/java/net/micode/notes/tool/ResourceParser.java index 1ad3ad6..d90f65f 100644 --- a/src/main/java/net/micode/notes/tool/ResourceParser.java +++ b/src/main/java/net/micode/notes/tool/ResourceParser.java @@ -21,25 +21,38 @@ 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, @@ -47,7 +60,7 @@ public class ResourceParser { 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, @@ -55,16 +68,16 @@ public class ResourceParser { 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)) { @@ -73,8 +86,9 @@ public class ResourceParser { 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, @@ -82,7 +96,7 @@ public class ResourceParser { 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, @@ -90,7 +104,7 @@ public class ResourceParser { 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, @@ -98,7 +112,7 @@ public class ResourceParser { 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, @@ -106,29 +120,30 @@ public class ResourceParser { 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, @@ -136,11 +151,11 @@ public class ResourceParser { 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, @@ -148,20 +163,21 @@ public class ResourceParser { 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. @@ -173,7 +189,7 @@ public class ResourceParser { } return TEXTAPPEARANCE_RESOURCES[id]; } - + //获取文本显示的长度 public static int getResourcesSize() { return TEXTAPPEARANCE_RESOURCES.length; } diff --git a/src/main/java/net/micode/notes/ui/NoteEditActivity.java b/src/main/java/net/micode/notes/ui/NoteEditActivity.java index 96a9ff8..b43ddc7 100644 --- a/src/main/java/net/micode/notes/ui/NoteEditActivity.java +++ b/src/main/java/net/micode/notes/ui/NoteEditActivity.java @@ -74,7 +74,7 @@ import java.util.regex.Pattern; public class NoteEditActivity extends Activity implements OnClickListener, NoteSettingChangedListener, OnTextViewChangeListener { - private class HeadViewHolder { + private class HeadViewHolder {//创建一个私有类HeadViewHolder用于对界面进行设置，包括文本内容，图片内容等 public TextView tvModified; public ImageView ivAlertIcon; @@ -82,10 +82,10 @@ public class NoteEditActivity extends Activity implements OnClickListener, public TextView tvAlertDate; public ImageView ibSetBgColor; - } - + }//该类实现了对当前便签界面进行编辑功能，继承了父类Activity并实现了接口，封装有方法39个 + //声明Hashmap类，将按钮和对应的资源解析器中的各个属性关联。 private static final Map sBgSelectorBtnsMap = new HashMap(); - static { + 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); @@ -94,6 +94,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, } 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); @@ -103,7 +104,8 @@ public class NoteEditActivity extends Activity implements OnClickListener, } private static final Map sFontSizeBtnsMap = new HashMap(); - static { + //将字体的大小与相对应的选择相连接 + 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); @@ -111,46 +113,48 @@ public class NoteEditActivity extends Activity implements OnClickListener, } private static final Map sFontSelectorSelectionMap = new HashMap(); - static { + //常量，实现资源解析器中字号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"; + private static final String TAG = "NoteEditActivity";//为本模块进行标签设置“NoteEditActivity" - private HeadViewHolder mNoteHeaderHolder; + private HeadViewHolder mNoteHeaderHolder;//.头部布局 - private View mHeadViewPanel; + private View mHeadViewPanel;//操作表头 - private View mNoteBgColorSelector; + private View mNoteBgColorSelector;//背景颜色 - private View mFontSizeSelector; + private View mFontSizeSelector;//私有化一个界面操作mFontSizeSelector，对标签字体的操作 - private EditText mNoteEditor; + private EditText mNoteEditor;//文本操作 - private View mNoteEditorPanel; + private View mNoteEditorPanel;//.文本编辑控制板 - private WorkingNote mWorkingNote; + private WorkingNote mWorkingNote;//对模板WorkingNote的初始化 - private SharedPreferences mSharedPrefs; - private int mFontSizeId; + private SharedPreferences mSharedPrefs;//私有化SharedPreferences的数据存储方式 + private int mFontSizeId;//.操作字体大小 - private static final String PREFERENCE_FONT_SIZE = "pref_font_size"; + private static final String PREFERENCE_FONT_SIZE = "pref_font_size";//定义常量 字体大小设置 - private static final int SHORTCUT_ICON_TITLE_MAX_LEN = 10; + 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'); + public static final String TAG_CHECKED = String.valueOf('\u221A');//定义字符串常量 已标记 + public static final String TAG_UNCHECKED = String.valueOf('\u25A1');//定义字符串常量 未标记 - private LinearLayout mEditTextList; + private LinearLayout mEditTextList;//线性布局 - private String mUserQuery; - private Pattern mPattern; + private String mUserQuery;//用户请求 + private Pattern mPattern;//正则表达式模式 - @Override - protected void onCreate(Bundle savedInstanceState) { + @Override//重写Activity类的onCreate方法 + //@param savedInstanceState 已保存的便签实例状态 + protected void onCreate(Bundle savedInstanceState) {//创建该activity，然后对content进行设置。通过对State的相关信息判断是否返回 super.onCreate(savedInstanceState); this.setContentView(R.layout.note_edit); @@ -166,7 +170,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, * user load this activity, we should restore the former state */ @Override - protected void onRestoreInstanceState(Bundle savedInstanceState) { + protected void onRestoreInstanceState(Bundle savedInstanceState) {//为防止内存不足时程序的终止，在这里有一个保存现场的函数 super.onRestoreInstanceState(savedInstanceState); if (savedInstanceState != null && savedInstanceState.containsKey(Intent.EXTRA_UID)) { Intent intent = new Intent(Intent.ACTION_VIEW); @@ -179,13 +183,13 @@ public class NoteEditActivity extends Activity implements OnClickListener, } } - private boolean initActivityState(Intent intent) { + 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())) { + 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 = ""; @@ -214,7 +218,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, 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())) { + } else if(TextUtils.equals(Intent.ACTION_INSERT_OR_EDIT, intent.getAction())) {//通过 getAction得到的字符串，来决定做什么 // New note long folderId = intent.getLongExtra(Notes.INTENT_EXTRA_FOLDER_ID, 0); int widgetId = intent.getIntExtra(Notes.INTENT_EXTRA_WIDGET_ID, @@ -263,21 +267,21 @@ public class NoteEditActivity extends Activity implements OnClickListener, } @Override - protected void onResume() { + protected void onResume() {//进行重新返回的函数 super.onResume(); initNoteScreen(); } - private void initNoteScreen() { + private void initNoteScreen() {//对界面进行初始化的操作 mNoteEditor.setTextAppearance(this, TextAppearanceResources .getTexAppearanceResource(mFontSizeId)); - if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) { + 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()) { + for (Integer id : sBgSelectorSelectionMap.keySet()) {//循环遍历所有sBgSelectorSelectionMap中id对应的资源文件，使其不可见且不占用空间 findViewById(sBgSelectorSelectionMap.get(id)).setVisibility(View.GONE); } mHeadViewPanel.setBackgroundResource(mWorkingNote.getTitleBgResId()); @@ -295,7 +299,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, showAlertHeader(); } - private void showAlertHeader() { + private void showAlertHeader() {//设置闹钟的显示 if (mWorkingNote.hasClockAlert()) { long time = System.currentTimeMillis(); if (time > mWorkingNote.getAlertDate()) { @@ -313,20 +317,20 @@ public class NoteEditActivity extends Activity implements OnClickListener, } @Override - protected void onNewIntent(Intent intent) { + protected void onNewIntent(Intent intent) {//新建一个传值对象 super.onNewIntent(intent); initActivityState(intent); } @Override - protected void onSaveInstanceState(Bundle outState) { + 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()) { + if (!mWorkingNote.existInDatabase()) {//如果该workingnote实例无法在数据库中找到，即为新建的便签，则先将其存储 saveNote(); } outState.putLong(Intent.EXTRA_UID, mWorkingNote.getNoteId()); @@ -334,8 +338,8 @@ public class NoteEditActivity extends Activity implements OnClickListener, } @Override - public boolean dispatchTouchEvent(MotionEvent ev) { - if (mNoteBgColorSelector.getVisibility() == View.VISIBLE + public boolean dispatchTouchEvent(MotionEvent ev) {//MotionEvent是对屏幕触控的传递机制 + if (mNoteBgColorSelector.getVisibility() == View.VISIBLE//背景颜色选择器是否可见 && !inRangeOfView(mNoteBgColorSelector, ev)) { mNoteBgColorSelector.setVisibility(View.GONE); return true; @@ -349,7 +353,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, return super.dispatchTouchEvent(ev); } - private boolean inRangeOfView(View view, MotionEvent ev) { + private boolean inRangeOfView(View view, MotionEvent ev) {//对屏幕触控的坐标进行操作 int []location = new int[2]; view.getLocationOnScreen(location); int x = location[0]; @@ -363,7 +367,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, return true; } - private void initResources() { + private void initResources() {//对标签各项属性内容的初始化 mHeadViewPanel = findViewById(R.id.note_title); mNoteHeaderHolder = new HeadViewHolder(); mNoteHeaderHolder.tvModified = (TextView) findViewById(R.id.tv_modified_date); @@ -374,46 +378,46 @@ public class NoteEditActivity extends Activity implements OnClickListener, 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()) { + 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()) { + 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); + mSharedPrefs = PreferenceManager.getDefaultSharedPreferences(this);//初始化共享设置 + mFontSizeId = mSharedPrefs.getInt(PREFERENCE_FONT_SIZE, ResourceParser.BG_DEFAULT_FONT_SIZE);//从偏好设置中得到设置字体大小的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(mFontSizeId >= TextAppearanceResources.getResourcesSize()) { + if(mFontSizeId >= TextAppearanceResources.getResourcesSize()) {//如果获取到的字体大小值的长度大于资源文件应有长度，则将其设置为默认长度，缺省值为1. mFontSizeId = ResourceParser.BG_DEFAULT_FONT_SIZE; } mEditTextList = (LinearLayout) findViewById(R.id.note_edit_list); } @Override - protected void onPause() { + protected void onPause() {//onPause()在activity退出前想保存用户重要数据的，必须在onPause中处理，调用父类的界面暂停操作，并输出对应信息。 super.onPause(); - if(saveNote()) { + 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); - if (mWorkingNote.getWidgetType() == Notes.TYPE_WIDGET_2X) { + 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) { + } else if (mWorkingNote.getWidgetType() == Notes.TYPE_WIDGET_4X) {//如果是4倍大小 intent.setClass(this, NoteWidgetProvider_4x.class); } else { - Log.e(TAG, "Unspported widget type"); + Log.e(TAG, "Unspported widget type");//Log输出error信息，不支持的widget类型 return; } @@ -427,16 +431,15 @@ public class NoteEditActivity extends Activity implements OnClickListener, public void onClick(View v) { int id = v.getId(); - if (id == R.id.btn_set_bg_color) { + if (id == R.id.btn_set_bg_color) {//如果点击的是 设置背景颜色，执行下面的函数。 mNoteBgColorSelector.setVisibility(View.VISIBLE); - findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility( - - View.VISIBLE); - } else if (sBgSelectorBtnsMap.containsKey(id)) { + findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility(View.VISIBLE); + } else if (sBgSelectorBtnsMap.containsKey(id)) {//如果点击的是背景颜色设置器中的背景颜色选项按钮，执行下面的函数 findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility( View.GONE); mWorkingNote.setBgColorId(sBgSelectorBtnsMap.get(id)); mNoteBgColorSelector.setVisibility(View.GONE); - } else if (sFontSizeBtnsMap.containsKey(id)) { + } else if (sFontSizeBtnsMap.containsKey(id)) {//如果点击的是文字大小设置器中的文字大小选项按钮 findViewById(sFontSelectorSelectionMap.get(mFontSizeId)).setVisibility(View.GONE); mFontSizeId = sFontSizeBtnsMap.get(id); mSharedPrefs.edit().putInt(PREFERENCE_FONT_SIZE, mFontSizeId).commit(); @@ -453,7 +456,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, } @Override - public void onBackPressed() { + public void onBackPressed() {//监听按下返回键的操作。 if(clearSettingState()) { return; } @@ -462,18 +465,18 @@ public class NoteEditActivity extends Activity implements OnClickListener, super.onBackPressed(); } - private boolean clearSettingState() { - if (mNoteBgColorSelector.getVisibility() == View.VISIBLE) { + private boolean clearSettingState() {//清除设置状态 + if (mNoteBgColorSelector.getVisibility() == View.VISIBLE) {//如果背景色选择器可见，设置为不可见 mNoteBgColorSelector.setVisibility(View.GONE); return true; - } else if (mFontSizeSelector.getVisibility() == View.VISIBLE) { + } else if (mFontSizeSelector.getVisibility() == View.VISIBLE) {//如果字体选择菜单可见，设置为不可见 mFontSizeSelector.setVisibility(View.GONE); return true; } return false; } - public void onBackgroundColorChanged() { + public void onBackgroundColorChanged() {//背景颜色改变 findViewById(sBgSelectorSelectionMap.get(mWorkingNote.getBgColorId())).setVisibility( View.VISIBLE); mNoteEditorPanel.setBackgroundResource(mWorkingNote.getBgColorResId()); @@ -481,23 +484,23 @@ public class NoteEditActivity extends Activity implements OnClickListener, } @Override - public boolean onPrepareOptionsMenu(Menu menu) { - if (isFinishing()) { + public boolean onPrepareOptionsMenu(Menu menu) {//准备菜单内容 + if (isFinishing()) {//如果窗口正在关闭，则不做处理 return true; } - clearSettingState(); - menu.clear(); - if (mWorkingNote.getFolderId() == Notes.ID_CALL_RECORD_FOLDER) { + 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) { + 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()) { + if (mWorkingNote.hasClockAlert()) {//如果workingNote对象中有时钟提醒事项，则执行下面函数。 menu.findItem(R.id.menu_alert).setVisible(false); } else { menu.findItem(R.id.menu_delete_remind).setVisible(false); @@ -506,8 +509,8 @@ public class NoteEditActivity extends Activity implements OnClickListener, } @Override - public boolean onOptionsItemSelected(MenuItem item) { - switch (item.getItemId()) { + public boolean onOptionsItemSelected(MenuItem item) {//动态改变菜单选项内容 + switch (item.getItemId()) {//判断选择项 case R.id.menu_new_note: createNewNote(); break; @@ -553,7 +556,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, return true; } - private void setReminder() { + private void setReminder() {//建立事件提醒器 DateTimePickerDialog d = new DateTimePickerDialog(this, System.currentTimeMillis()); d.setOnDateTimeSetListener(new OnDateTimeSetListener() { public void OnDateTimeSet(AlertDialog dialog, long date) { @@ -567,14 +570,14 @@ public class NoteEditActivity extends Activity implements OnClickListener, * Share note to apps that support {@link Intent#ACTION_SEND} action * and {@text/plain} type */ - private void sendTo(Context context, String info) { + 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() { + private void createNewNote() {//创建新的便签 // Firstly, save current editing notes saveNote(); @@ -586,16 +589,16 @@ public class NoteEditActivity extends Activity implements OnClickListener, startActivity(intent); } - private void deleteCurrentNote() { - if (mWorkingNote.existInDatabase()) { + private void deleteCurrentNote() {//删除当前便签 + if (mWorkingNote.existInDatabase()) {//先判断便签是否在数据库中 HashSet ids = new HashSet(); long id = mWorkingNote.getNoteId(); - if (id != Notes.ID_ROOT_FOLDER) { + if (id != Notes.ID_ROOT_FOLDER) {//如果不是头文件夹建立一个hash表把便签id存起来 ids.add(id); } else { Log.d(TAG, "Wrong note id, should not happen"); } - if (!isSyncMode()) { + if (!isSyncMode()) {//如果不是同步模式，则执行下面函数 if (!DataUtils.batchDeleteNotes(getContentResolver(), ids)) { Log.e(TAG, "Delete Note error"); } @@ -608,19 +611,19 @@ public class NoteEditActivity extends Activity implements OnClickListener, mWorkingNote.markDeleted(true); } - private boolean isSyncMode() { + private boolean isSyncMode() {//判断是否为同步模式 return NotesPreferenceActivity.getSyncAccountName(this).trim().length() > 0; } - public void onClockAlertChanged(long date, boolean set) { + 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()) { + if (!mWorkingNote.existInDatabase()) {//如果设置提醒的便签未保存，则先保存 saveNote(); } - if (mWorkingNote.getNoteId() > 0) { + 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); @@ -645,24 +648,25 @@ public class NoteEditActivity extends Activity implements OnClickListener, public void onWidgetChanged() { updateWidget(); } + //当widget变化时，执行更新widget这个函数 - public void onEditTextDelete(int index, String text) { + public void onEditTextDelete(int index, String text) {//当删除编辑文本时，执行这个函数 int childCount = mEditTextList.getChildCount(); - if (childCount == 1) { + if (childCount == 1) {//当删除编辑文本时，执行这个函数 return; } - for (int i = index + 1; i < childCount; i++) { + 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) { + if(index == 0) {//如果index为0，则将edit定位到第一个EditText项 edit = (NoteEditText) mEditTextList.getChildAt(0).findViewById( R.id.et_edit_text); - } else { + } else {//index不为0，则将edit定位到index-1对应的EditText项 edit = (NoteEditText) mEditTextList.getChildAt(index - 1).findViewById( R.id.et_edit_text); } @@ -672,11 +676,11 @@ public class NoteEditActivity extends Activity implements OnClickListener, edit.setSelection(length); } - public void onEditTextEnter(int index, String text) { + public void onEditTextEnter(int index, String text) {//当编辑便签中输入enter时执行该函数 /** * Should not happen, check for debug */ - if(index > mEditTextList.getChildCount()) { + if(index > mEditTextList.getChildCount()) {//如果越界就报错 Log.e(TAG, "Index out of mEditTextList boundrary, should not happen"); } @@ -685,17 +689,17 @@ public class NoteEditActivity extends Activity implements OnClickListener, NoteEditText edit = (NoteEditText) view.findViewById(R.id.et_edit_text); edit.requestFocus(); edit.setSelection(0); - for (int i = index + 1; i < mEditTextList.getChildCount(); i++) { + 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) { + private void switchToListMode(String text) {//该函数转到列表模式 mEditTextList.removeAllViews(); String[] items = text.split("\n"); int index = 0; - for (String item : items) { + for (String item : items) {//清空所有视图，初始化下标 if(!TextUtils.isEmpty(item)) { mEditTextList.addView(getListItem(item, index)); index++; @@ -708,13 +712,13 @@ public class NoteEditActivity extends Activity implements OnClickListener, mEditTextList.setVisibility(View.VISIBLE); } - private Spannable getHighlightQueryResult(String fullText, String userQuery) { + private Spannable getHighlightQueryResult(String fullText, String userQuery) {//获取高亮效果的反馈结果 SpannableString spannable = new SpannableString(fullText == null ? "" : fullText); - if (!TextUtils.isEmpty(userQuery)) { + if (!TextUtils.isEmpty(userQuery)) {//将用户的询问进行解析，如果搜索结果不为空，执行下面函数 mPattern = Pattern.compile(userQuery); Matcher m = mPattern.matcher(fullText); int start = 0; - while (m.find(start)) { + while (m.find(start)) {//将匹配到的内容设置为高亮。 spannable.setSpan( new BackgroundColorSpan(this.getResources().getColor( R.color.user_query_highlight)), m.start(), m.end(), @@ -725,13 +729,13 @@ public class NoteEditActivity extends Activity implements OnClickListener, return spannable; } - private View getListItem(String item, int index) { + private View getListItem(String item, int index) {//获取列表项 View view = LayoutInflater.from(this).inflate(R.layout.note_edit_list_item, null); final NoteEditText edit = (NoteEditText) view.findViewById(R.id.et_edit_text); edit.setTextAppearance(this, TextAppearanceResources.getTexAppearanceResource(mFontSizeId)); CheckBox cb = ((CheckBox) view.findViewById(R.id.cb_edit_item)); cb.setOnCheckedChangeListener(new OnCheckedChangeListener() { - public void onCheckedChanged(CompoundButton buttonView, boolean isChecked) { + public void onCheckedChanged(CompoundButton buttonView, boolean isChecked) {//如果CheckBox已勾选，则执行下面函数，设置显示方式。 if (isChecked) { edit.setPaintFlags(edit.getPaintFlags() | Paint.STRIKE_THRU_TEXT_FLAG); } else { @@ -740,11 +744,11 @@ public class NoteEditActivity extends Activity implements OnClickListener, } }); - if (item.startsWith(TAG_CHECKED)) { + 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)) { + } 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(); @@ -756,20 +760,20 @@ public class NoteEditActivity extends Activity implements OnClickListener, return view; } - public void onTextChange(int index, boolean hasText) { - if (index >= mEditTextList.getChildCount()) { + public void onTextChange(int index, boolean hasText) {//便签内容发生改变所 触发的事件 + if (index >= mEditTextList.getChildCount()) {//越界报错 Log.e(TAG, "Wrong index, should not happen"); return; } - if(hasText) { + if(hasText) {//如果内容不为空则将其子编辑框可见性置为可见，否则不可见 mEditTextList.getChildAt(index).findViewById(R.id.cb_edit_item).setVisibility(View.VISIBLE); - } else { + } 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) { + public void onCheckListModeChanged(int oldMode, int newMode) {//检查模式和列表模式的切换 + if (newMode == TextNote.MODE_CHECK_LIST) {// 如果是变为清单模式 switchToListMode(mNoteEditor.getText().toString()); } else { if (!getWorkingText()) { @@ -782,11 +786,11 @@ public class NoteEditActivity extends Activity implements OnClickListener, } } - private boolean getWorkingText() { + private boolean getWorkingText() {//设置勾选选项表并返回是否勾选的标记 boolean hasChecked = false; - if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) { + if (mWorkingNote.getCheckListMode() == TextNote.MODE_CHECK_LIST) {//判断是否是清单模式 StringBuilder sb = new StringBuilder(); - for (int i = 0; i < mEditTextList.getChildCount(); i++) { + 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())) { @@ -799,16 +803,16 @@ public class NoteEditActivity extends Activity implements OnClickListener, } } mWorkingNote.setWorkingText(sb.toString()); - } else { + } else {//若不是该模式直接用编辑器中的内容设置运行中标签的内容 mWorkingNote.setWorkingText(mNoteEditor.getText().toString()); } return hasChecked; } - private boolean saveNote() { + private boolean saveNote() {//保存便签 getWorkingText(); boolean saved = mWorkingNote.saveNote(); - if (saved) { + 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 @@ -821,17 +825,17 @@ public class NoteEditActivity extends Activity implements OnClickListener, return saved; } - private void sendToDesktop() { + 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()) { + if (!mWorkingNote.existInDatabase()) {//若不存在数据也就是新的标签就先保存 saveNote(); } - if (mWorkingNote.getNoteId() > 0) { + if (mWorkingNote.getNoteId() > 0) {//若便签的id大于0，则执行以下程序 Intent sender = new Intent(); Intent shortcutIntent = new Intent(this, NoteEditActivity.class); shortcutIntent.setAction(Intent.ACTION_VIEW); @@ -845,7 +849,7 @@ public class NoteEditActivity extends Activity implements OnClickListener, sender.setAction("com.android.launcher.action.INSTALL_SHORTCUT"); showToast(R.string.info_note_enter_desktop); sendBroadcast(sender); - } else { + } 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 @@ -856,18 +860,20 @@ public class NoteEditActivity extends Activity implements OnClickListener, } } - private String makeShortcutIconTitle(String content) { + 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; + SHORTCUT_ICON_TITLE_MAX_LEN) : content;//直接设置为content中的内容并返回，有勾选和未勾选2种 } - private void showToast(int resId) { + 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/src/main/java/net/micode/notes/ui/NoteEditText.java b/src/main/java/net/micode/notes/ui/NoteEditText.java index 2afe2a8..b85575c 100644 --- a/src/main/java/net/micode/notes/ui/NoteEditText.java +++ b/src/main/java/net/micode/notes/ui/NoteEditText.java @@ -37,17 +37,17 @@ import net.micode.notes.R; import java.util.HashMap; import java.util.Map; -public class NoteEditText extends EditText { - private static final String TAG = "NoteEditText"; +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_TEL = "tel:" ;//声明字符串常量，标志电话、网址、邮件 private static final String SCHEME_HTTP = "http:" ; private static final String SCHEME_EMAIL = "mailto:" ; - private static final Map sSchemaActionResMap = new HashMap(); - static { + 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); @@ -56,52 +56,52 @@ public class NoteEditText extends EditText { /** * Call by the {@link NoteEditActivity} to delete or add edit text */ - public interface OnTextViewChangeListener { + 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); + 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); + void onEditTextEnter(int index, String text);//当触发输入文本KeyEvent时增添文本 /** * Hide or show item option when text change */ - void onTextChange(int index, boolean hasText); + void onTextChange(int index, boolean hasText);//文字更改时隐藏或显示项目选项 } private OnTextViewChangeListener mOnTextViewChangeListener; - public NoteEditText(Context context) { + public NoteEditText(Context context) {//这个函数是NoteEditText的构造函数,直接借用了父类的构造函数 super(context, null); mIndex = 0; } - public void setIndex(int index) { - mIndex = index; + public void setIndex(int index){//这个函数设置了针对textview的监听器 + mIndex = index; } - public void setOnTextViewChangeListener(OnTextViewChangeListener listener) { + public void setOnTextViewChangeListener(OnTextViewChangeListener listener) {//置文本视图变化监听器 mOnTextViewChangeListener = listener; } - public NoteEditText(Context context, AttributeSet attrs) { + public NoteEditText(Context context, AttributeSet attrs) {//便签初始化 super(context, attrs, android.R.attr.editTextStyle); } - public NoteEditText(Context context, AttributeSet attrs, int defStyle) { + 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()) { + public boolean onTouchEvent(MotionEvent event) {//我们打开一个便签后触碰它的文本内容时,该便签就会跳转到响应的编辑状态.这个函数设计了当我们在便签文本编辑视图中触碰文本后系统的响应方式 + switch (event.getAction()) {//根据按键的KeyCode来处理 case MotionEvent.ACTION_DOWN: int x = (int) event.getX(); @@ -123,7 +123,7 @@ public class NoteEditText extends EditText { @Override public boolean onKeyDown(int keyCode, KeyEvent event) { - switch (keyCode) { + switch (keyCode) {//根据按键的KeyCode来处理 case KeyEvent.KEYCODE_ENTER: if (mOnTextViewChangeListener != null) { return false; @@ -139,8 +139,8 @@ public class NoteEditText extends EditText { } @Override - public boolean onKeyUp(int keyCode, KeyEvent event) { - switch(keyCode) { + public boolean onKeyUp(int keyCode, KeyEvent event) {//这个函数规定了当用户松开按键瞬间系统的响应 + switch(keyCode) {//根据按键的 Unicode 编码值来处理，有删除和进入2种操作 case KeyEvent.KEYCODE_DEL: if (mOnTextViewChangeListener != null) { if (0 == mSelectionStartBeforeDelete && mIndex != 0) { @@ -168,7 +168,7 @@ public class NoteEditText extends EditText { } @Override - protected void onFocusChanged(boolean focused, int direction, Rect previouslyFocusedRect) { + protected void onFocusChanged(boolean focused, int direction, Rect previouslyFocusedRect) {//这个函数规定了编辑文本焦点改变时的系统响应 if (mOnTextViewChangeListener != null) { if (!focused && TextUtils.isEmpty(getText())) { mOnTextViewChangeListener.onTextChange(mIndex, false); @@ -180,8 +180,8 @@ public class NoteEditText extends EditText { } @Override - protected void onCreateContextMenu(ContextMenu menu) { - if (getText() instanceof Spanned) { + protected void onCreateContextMenu(ContextMenu menu) {//这个重载函数定义了新建文本菜单的过程 + if (getText() instanceof Spanned) {//如果有文本存在 int selStart = getSelectionStart(); int selEnd = getSelectionEnd(); @@ -189,16 +189,16 @@ public class NoteEditText extends EditText { int max = Math.max(selStart, selEnd); final URLSpan[] urls = ((Spanned) getText()).getSpans(min, max, URLSpan.class); - if (urls.length == 1) { + if (urls.length == 1) {//设置url的信息的范围值 int defaultResId = 0; - for(String schema: sSchemaActionResMap.keySet()) { + for(String schema: sSchemaActionResMap.keySet()) {//获取计划表中所有的key值 if(urls[0].getURL().indexOf(schema) >= 0) { defaultResId = sSchemaActionResMap.get(schema); break; } } - if (defaultResId == 0) { + if (defaultResId == 0) {//defaultResId == 0则说明url并没有添加任何东西，所以置为连接其他SchemaActionResMap的值 defaultResId = R.string.note_link_other; } diff --git a/src/main/java/net/micode/notes/ui/NoteItemData.java b/src/main/java/net/micode/notes/ui/NoteItemData.java index 0f5a878..cf146db 100644 --- a/src/main/java/net/micode/notes/ui/NoteItemData.java +++ b/src/main/java/net/micode/notes/ui/NoteItemData.java @@ -26,8 +26,8 @@ import net.micode.notes.data.Notes.NoteColumns; import net.micode.notes.tool.DataUtils; -public class NoteItemData { - static final String [] PROJECTION = new String [] { +public class NoteItemData {//提供便签的项目数据 + static final String [] PROJECTION = new String [] {//常量标记和数据 NoteColumns.ID, NoteColumns.ALERTED_DATE, NoteColumns.BG_COLOR_ID, @@ -42,7 +42,7 @@ public class NoteItemData { NoteColumns.WIDGET_TYPE, }; - private static final int ID_COLUMN = 0; + 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; @@ -76,51 +76,52 @@ public class NoteItemData { private boolean mIsOneNoteFollowingFolder; private boolean mIsMultiNotesFollowingFolder; - public NoteItemData(Context context, Cursor cursor) { - mId = cursor.getLong(ID_COLUMN); + 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; + 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( + 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) { + 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) { + if (mName == null) {//如果没有对name复制成功，则把name设置为空值 mName = ""; } checkPostion(cursor); } - private void checkPostion(Cursor 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) { + if (mType == Notes.TYPE_NOTE && !mIsFirstItem) {//如果是note格式并且不是第一个元素，则获取光标位置并根据上一行信息更改标记 int position = cursor.getPosition(); - if (cursor.moveToPrevious()) { + if (cursor.moveToPrevious()) {//获取光标位置后看上一行 if (cursor.getInt(TYPE_COLUMN) == Notes.TYPE_FOLDER - || cursor.getInt(TYPE_COLUMN) == Notes.TYPE_SYSTEM) { + || cursor.getInt(TYPE_COLUMN) == Notes.TYPE_SYSTEM) {//若光标满足SYSTEM或FOLDER格式 if (cursor.getCount() > (position + 1)) { mIsMultiNotesFollowingFolder = true; } else { @@ -136,7 +137,7 @@ public class NoteItemData { public boolean isOneFollowingFolder() { return mIsOneNoteFollowingFolder; - } + }//以下都是获取标记的函数 public boolean isMultiFollowingFolder() { return mIsMultiNotesFollowingFolder; diff --git a/src/main/java/net/micode/notes/ui/NotesListActivity.java b/src/main/java/net/micode/notes/ui/NotesListActivity.java index e843aec..69d5a7a 100644 --- a/src/main/java/net/micode/notes/ui/NotesListActivity.java +++ b/src/main/java/net/micode/notes/ui/NotesListActivity.java @@ -79,65 +79,66 @@ import java.io.InputStreamReader; import java.util.HashSet; public class NotesListActivity extends Activity implements OnClickListener, OnItemLongClickListener { - private static final int FOLDER_NOTE_LIST_QUERY_TOKEN = 0; + //这个类继承于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 FOLDER_LIST_QUERY_TOKEN = 1;//查询记号 - private static final int MENU_FOLDER_DELETE = 0; + private static final int MENU_FOLDER_DELETE = 0;//删除菜单文件 - private static final int MENU_FOLDER_VIEW = 1; + private static final int MENU_FOLDER_VIEW = 1;// 阅读菜单文件 - private static final int MENU_FOLDER_CHANGE_NAME = 2; + private static final int MENU_FOLDER_CHANGE_NAME = 2;//更改菜单文件名称 - private static final String PREFERENCE_ADD_INTRODUCTION = "net.micode.notes.introduction"; + private static final String PREFERENCE_ADD_INTRODUCTION = "net.micode.notes.introduction";//用于第一次打开小米便签的判断 - private enum ListEditState { + private enum ListEditState {//列表编辑三种状态 NOTE_LIST, SUB_FOLDER, CALL_RECORD_FOLDER }; - private ListEditState mState; + private ListEditState mState;// 声明一些私有属性 - private BackgroundQueryHandler mBackgroundQueryHandler; + private BackgroundQueryHandler mBackgroundQueryHandler;//后台疑问处理功能 - private NotesListAdapter mNotesListAdapter; + private NotesListAdapter mNotesListAdapter;//便签列表配适器 - private ListView mNotesListView; + private ListView mNotesListView;//主界面的视图 - private Button mAddNewNote; + private Button mAddNewNote;//最下方添加便签的按钮 - private boolean mDispatch; + private boolean mDispatch;//是否调度的判断变量 - private int mOriginY; + private int mOriginY;//首次触摸时屏幕上的垂直距离（y值） - private int mDispatchY; + private int mDispatchY;//重新调度时的触摸的在屏幕上的垂直距离 - private TextView mTitleBar; + private TextView mTitleBar;//子文件夹下的标头 - private long mCurrentFolderId; + private long mCurrentFolderId;//当前文件夹的ID - private ContentResolver mContentResolver; + private ContentResolver mContentResolver;//提供内容分析 - private ModeCallback mModeCallBack; + private ModeCallback mModeCallBack;//返回调用方法 - private static final String TAG = "NotesListActivity"; + private static final String TAG = "NotesListActivity";//名称（可用于日志文件调试） - public static final int NOTES_LISTVIEW_SCROLL_RATE = 30; + public static final int NOTES_LISTVIEW_SCROLL_RATE = 30;//列表滚轮速度 - private NoteItemData mFocusNoteDataItem; + private NoteItemData mFocusNoteDataItem;//所指的便签数据内容 - private static final String NORMAL_SELECTION = NoteColumns.PARENT_ID + "=?"; + private static final String NORMAL_SELECTION = NoteColumns.PARENT_ID + "=?";//定义私有字符串变量 - private static final String ROOT_FOLDER_SELECTION = "(" + NoteColumns.TYPE + "<>" + 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; + 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); + protected void onCreate(Bundle savedInstanceState) {//创建类 + super.onCreate(savedInstanceState);//super调用父类的protected函数,创建窗口时使用 setContentView(R.layout.note_list); initResources(); @@ -148,38 +149,38 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } @Override - protected void onActivityResult(int requestCode, int resultCode, Intent data) { - if (resultCode == RESULT_OK + 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 { + } else {//如果条件不满足，则将数据返回给父类，即调用父类的onActivityResult()。 super.onActivityResult(requestCode, resultCode, data); } } - private void setAppInfoFromRawRes() { + private void setAppInfoFromRawRes() {//从原始数据里生成应用的基本信息。 SharedPreferences sp = PreferenceManager.getDefaultSharedPreferences(this); - if (!sp.getBoolean(PREFERENCE_ADD_INTRODUCTION, false)) { + if (!sp.getBoolean(PREFERENCE_ADD_INTRODUCTION, false)) {//判断偏好，增加说明 StringBuilder sb = new StringBuilder(); InputStream in = null; - try { + try {//从原始配置文件当中获取基本信息 in = getResources().openRawResource(R.raw.introduction); - if (in != null) { + 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) { + while ((len = br.read(buf)) > 0) {//不断在buf中读取数据放入sb里 sb.append(buf, 0, len); } } else { - Log.e(TAG, "Read introduction file error"); + Log.e(TAG, "Read introduction file error");//报错，读取文件错误 return; } - } catch (IOException e) { + } catch (IOException e) {//获取IO中断异常 e.printStackTrace(); return; - } finally { + } finally {// finally是必然会执行的部分 if(in != null) { try { in.close(); @@ -194,7 +195,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt AppWidgetManager.INVALID_APPWIDGET_ID, Notes.TYPE_WIDGET_INVALIDE, ResourceParser.RED); note.setWorkingText(sb.toString()); - if (note.saveNote()) { + if (note.saveNote()) {//判断便签是否保存成功。 sp.edit().putBoolean(PREFERENCE_ADD_INTRODUCTION, true).commit(); } else { Log.e(TAG, "Save introduction note error"); @@ -204,12 +205,12 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } @Override - protected void onStart() { + protected void onStart() {//调用父类的onCreate活动，和同步便签列表 super.onStart(); startAsyncNotesListQuery(); } - private void initResources() { + private void initResources() {//初始化资源 mContentResolver = this.getContentResolver(); mBackgroundQueryHandler = new BackgroundQueryHandler(this.getContentResolver()); mCurrentFolderId = Notes.ID_ROOT_FOLDER; @@ -232,18 +233,19 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } 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) { + 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) { + || DataUtils.getUserFolderCount(mContentResolver) == 0) {//如果父类id在文件夹中保存或者用户文件数量为零，设置移动菜单为不可见，否者设为可见 mMoveMenu.setVisible(false); - } else { + } else {//设置菜单项目为可见 mMoveMenu.setVisible(true); mMoveMenu.setOnMenuItemClickListener(this); } @@ -259,7 +261,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt (Button) customView.findViewById(R.id.selection_menu), R.menu.note_list_dropdown); mDropDownMenu.setOnDropdownMenuItemClickListener(new PopupMenu.OnMenuItemClickListener(){ - public boolean onMenuItemClick(MenuItem item) { + public boolean onMenuItemClick(MenuItem item) {//点击菜单时，设置为全选并更新菜单 mNotesListAdapter.selectAll(!mNotesListAdapter.isAllSelected()); updateMenu(); return true; @@ -269,13 +271,14 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt return true; } - private void updateMenu() { + 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 (item != null) {//当全选成功，则将“全选”菜单项改为“取消全选”菜单，否则仍保持“全选”菜单项。 if (mNotesListAdapter.isAllSelected()) { item.setChecked(true); item.setTitle(R.string.menu_deselect_all); @@ -286,40 +289,41 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } - public boolean onPrepareActionMode(ActionMode mode, Menu menu) { + public boolean onPrepareActionMode(ActionMode mode, Menu menu) {//准备动作模式 // TODO Auto-generated method stub return false; } - public boolean onActionItemClicked(ActionMode mode, MenuItem item) { + public boolean onActionItemClicked(ActionMode mode, MenuItem item) {//菜单动作触发标记 // TODO Auto-generated method stub return false; } - public void onDestroyActionMode(ActionMode mode) { + 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) { + boolean checked) {//勾选的状态改变时，更改勾选状态，更新菜单 mNotesListAdapter.setCheckedItem(position, checked); updateMenu(); } - public boolean onMenuItemClick(MenuItem item) { - if (mNotesListAdapter.getSelectedCount() == 0) { + 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()) { + switch (item.getItemId()) {//根据id号判断是删除还是移动 case R.id.delete: AlertDialog.Builder builder = new AlertDialog.Builder(NotesListActivity.this); builder.setTitle(getString(R.string.alert_title_delete)); @@ -346,10 +350,10 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } - private class NewNoteOnTouchListener implements OnTouchListener { + private class NewNoteOnTouchListener implements OnTouchListener {//触摸便签监听器 - public boolean onTouch(View v, MotionEvent event) { - switch (event.getAction()) { + public boolean onTouch(View v, MotionEvent event) {//新建便签的触摸事件的处理 + switch (event.getAction()) {//获取不同动作对应不同操作 case MotionEvent.ACTION_DOWN: { Display display = getWindowManager().getDefaultDisplay(); int screenHeight = display.getHeight(); @@ -359,7 +363,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt /** * Minus TitleBar's height */ - if (mState == ListEditState.SUB_FOLDER) { + if (mState == ListEditState.SUB_FOLDER) {//如果再其他文件夹下，则需要减去子文件夹的title的高度 eventY -= mTitleBar.getHeight(); start -= mTitleBar.getHeight(); } @@ -372,11 +376,11 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt * 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)) { + 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))) { + && (view.getTop() < (start + 94))) {//如果不在新建便签的按钮上，重新调度响应按键 mOriginY = (int) event.getY(); mDispatchY = eventY; event.setLocation(event.getX(), mDispatchY); @@ -386,7 +390,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } break; } - case MotionEvent.ACTION_MOVE: { + case MotionEvent.ACTION_MOVE: {//如果是移动操作，调度动作顺序 if (mDispatch) { mDispatchY += (int) event.getY() - mOriginY; event.setLocation(event.getX(), mDispatchY); @@ -396,7 +400,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } default: { if (mDispatch) { - event.setLocation(event.getX(), mDispatchY); + event.setLocation(event.getX(), mDispatchY);//重新赋值 mDispatch = false; return mNotesListView.dispatchTouchEvent(event); } @@ -408,7 +412,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt }; - private void startAsyncNotesListQuery() { + private void startAsyncNotesListQuery() {//同步便签列表请求 String selection = (mCurrentFolderId == Notes.ID_ROOT_FOLDER) ? ROOT_FOLDER_SELECTION : NORMAL_SELECTION; mBackgroundQueryHandler.startQuery(FOLDER_NOTE_LIST_QUERY_TOKEN, null, @@ -417,18 +421,19 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt }, NoteColumns.TYPE + " DESC," + NoteColumns.MODIFIED_DATE + " DESC"); } - private final class BackgroundQueryHandler extends AsyncQueryHandler { + private final class BackgroundQueryHandler extends AsyncQueryHandler {//背景请求处理器 public BackgroundQueryHandler(ContentResolver contentResolver) { + //调用父类的方法 super(contentResolver); } @Override - protected void onQueryComplete(int token, Object cookie, Cursor cursor) { + protected void onQueryComplete(int token, Object cookie, Cursor cursor) {//查询完成后对光标的处理 switch (token) { - case FOLDER_NOTE_LIST_QUERY_TOKEN: + case FOLDER_NOTE_LIST_QUERY_TOKEN://如果是便签查询被采用，更改光标位置 mNotesListAdapter.changeCursor(cursor); break; - case FOLDER_LIST_QUERY_TOKEN: + case FOLDER_LIST_QUERY_TOKEN://如果是采用列表查询，显示菜单列表 if (cursor != null && cursor.getCount() > 0) { showFolderListMenu(cursor); } else { @@ -441,13 +446,13 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } - private void showFolderListMenu(Cursor cursor) { + 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); + final FoldersListAdapter adapter = new FoldersListAdapter(this, cursor);//文件夹列表配适器 builder.setAdapter(adapter, new DialogInterface.OnClickListener() { - public void onClick(DialogInterface dialog, int which) { + public void onClick(DialogInterface dialog, int which) {//为对话框设置监听事件 DataUtils.batchMoveToFolder(mContentResolver, mNotesListAdapter.getSelectedItemIds(), adapter.getItemId(which)); Toast.makeText( @@ -462,18 +467,18 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt builder.show(); } - private void createNewNote() { - Intent intent = new Intent(this, NoteEditActivity.class); + 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); + intent.putExtra(Notes.INTENT_EXTRA_FOLDER_ID, mCurrentFolderId);//设置键对值 + this.startActivityForResult(intent, REQUEST_CODE_NEW_NODE);//这个活动发出请求，等待下一个活动返回数据 } - private void batchDelete() { + private void batchDelete() {//批量删除便签 new AsyncTask>() { protected HashSet doInBackground(Void... unused) { HashSet widgets = mNotesListAdapter.getSelectedWidget(); - if (!isSyncMode()) { + if (!isSyncMode()) {//如果为同步模式则删除笔记，若删除不成功打印错误信息 // if not synced, delete notes directly if (DataUtils.batchDeleteNotes(mContentResolver, mNotesListAdapter .getSelectedItemIds())) { @@ -492,7 +497,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } @Override - protected void onPostExecute(HashSet widgets) { + protected void onPostExecute(HashSet widgets) {//这是一个循环体结构，如果id不等的话，会进行更新id的操作。 if (widgets != null) { for (AppWidgetAttribute widget : widgets) { if (widget.widgetId != AppWidgetManager.INVALID_APPWIDGET_ID @@ -506,7 +511,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt }.execute(); } - private void deleteFolder(long folderId) { + private void deleteFolder(long folderId) {//删除文件夹 if (folderId == Notes.ID_ROOT_FOLDER) { Log.e(TAG, "Wrong folder id, should not happen " + folderId); return; @@ -516,14 +521,14 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt ids.add(folderId); HashSet widgets = DataUtils.getFolderNoteWidget(mContentResolver, folderId); - if (!isSyncMode()) { + 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) { + if (widgets != null) {//如果存在对应桌面挂件，那么判断挂件信息，如果挂件id有效且挂件类型有效，则更新挂件信息 for (AppWidgetAttribute widget : widgets) { if (widget.widgetId != AppWidgetManager.INVALID_APPWIDGET_ID && widget.widgetType != Notes.TYPE_WIDGET_INVALIDE) { @@ -533,23 +538,23 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } - private void openNode(NoteItemData data) { - Intent intent = new Intent(this, NoteEditActivity.class); + 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) { + private void openFolder(NoteItemData data) {//打开文件夹 mCurrentFolderId = data.getId(); startAsyncNotesListQuery(); - if (data.getId() == Notes.ID_CALL_RECORD_FOLDER) { + 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) { + if (data.getId() == Notes.ID_CALL_RECORD_FOLDER) {//如果当前id是保存在文件夹的id，设置标题内容为文件夹名字，否则设置为文本的前部片段内容 mTitleBar.setText(R.string.call_record_folder_name); } else { mTitleBar.setText(data.getSnippet()); @@ -557,8 +562,8 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt mTitleBar.setVisibility(View.VISIBLE); } - public void onClick(View v) { - switch (v.getId()) { + public void onClick(View v) {//响应一个点击操作，创建一个新的便签 + switch (v.getId()) {//得到我们所点击组件的ID号并进行判断 case R.id.btn_new_note: createNewNote(); break; @@ -567,24 +572,24 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } - private void showSoftInput() { + private void showSoftInput() {//.显示软键盘 InputMethodManager inputMethodManager = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE); - if (inputMethodManager != null) { + if (inputMethodManager != null) {//若输入为空，进行对应操作，使软键盘显示，第二个参数hideFlags（用来设置是否隐藏）等于0 inputMethodManager.toggleSoftInput(InputMethodManager.SHOW_FORCED, 0); } } - private void hideSoftInput(View view) { + 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); + 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) { + if (!create) {//如果create==false将对话框标题设置为 修改文件夹名称，否则设置为新建文件夹 if (mFocusNoteDataItem != null) { etName.setText(mFocusNoteDataItem.getSnippet()); builder.setTitle(getString(R.string.menu_folder_change_name)); @@ -600,23 +605,24 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt 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) { + 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)) { + 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) { + if (!create) {//当文件名字存在时，判断是否为创建操作，若不是，则更新values信息，若是，则插入values信息 if (!TextUtils.isEmpty(name)) { ContentValues values = new ContentValues(); values.put(NoteColumns.SNIPPET, name); @@ -637,27 +643,27 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } }); - if (TextUtils.isEmpty(etName.getText())) { + 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) { + 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())) { + 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) { + public void afterTextChanged(Editable s) {//判断是否在文本更改之后 // TODO Auto-generated method stub } @@ -665,8 +671,8 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } @Override - public void onBackPressed() { - switch (mState) { + public void onBackPressed() {//按返回键时根据情况更改类中的数据 + switch (mState) {//判断目前所处的状态 case SUB_FOLDER: mCurrentFolderId = Notes.ID_ROOT_FOLDER; mState = ListEditState.NOTE_LIST; @@ -688,9 +694,9 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } } - private void updateWidget(int appWidgetId, int appWidgetType) { + private void updateWidget(int appWidgetId, int appWidgetType) {//更新不同widget的插件 Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_UPDATE); - if (appWidgetType == Notes.TYPE_WIDGET_2X) { + 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); @@ -699,7 +705,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt return; } - intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_IDS, new int[] { + intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_IDS, new int[] {//putExtra中两个参数为键对值，第一个参数为键名 appWidgetId }); @@ -707,9 +713,9 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt setResult(RESULT_OK, intent); } - private final OnCreateContextMenuListener mFolderOnCreateContextMenuListener = new OnCreateContextMenuListener() { - public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo) { - if (mFocusNoteDataItem != null) { + 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); @@ -719,20 +725,20 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt }; @Override - public void onContextMenuClosed(Menu menu) { + public void onContextMenuClosed(Menu menu) {//内容菜单关闭 if (mNotesListView != null) { - mNotesListView.setOnCreateContextMenuListener(null); + mNotesListView.setOnCreateContextMenuListener(null);//不设置监听事件 } super.onContextMenuClosed(menu); } @Override - public boolean onContextItemSelected(MenuItem item) { - if (mFocusNoteDataItem == null) { + public boolean onContextItemSelected(MenuItem item) {//对菜单项进行选择对应的相应 + if (mFocusNoteDataItem == null) {//若笔记数据项为空,则返回错误日志信息 Log.e(TAG, "The long click data item is null"); return false; } - switch (item.getItemId()) { + switch (item.getItemId()) {//根据项目id判断要执行的功能，分别是打开文件、删除文件以及更改文件名 case MENU_FOLDER_VIEW: openFolder(mFocusNoteDataItem); break; @@ -761,9 +767,9 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } @Override - public boolean onPrepareOptionsMenu(Menu menu) { + public boolean onPrepareOptionsMenu(Menu menu) {//创建菜单这个方法在每一次调用菜单的时候都会执行 menu.clear(); - if (mState == ListEditState.NOTE_LIST) { + if (mState == ListEditState.NOTE_LIST) {//如果是在便签列表的状态下，加载对应的菜单资源，下面同理 getMenuInflater().inflate(R.menu.note_list, menu); // set sync or sync_cancel menu.findItem(R.id.menu_sync).setTitle( @@ -779,8 +785,9 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } @Override - public boolean onOptionsItemSelected(MenuItem item) { - switch (item.getItemId()) { + public boolean onOptionsItemSelected(MenuItem item) {//实现菜单项目的操作，通过case语句对各个菜单项目分别设置事件 + switch (item.getItemId()) {//五个菜单项的响应实现 + //调用不同方法实现不同菜单项 case R.id.menu_new_folder: { showCreateOrModifyFolderDialog(true); break; @@ -790,13 +797,13 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt break; } case R.id.menu_sync: { - if (isSyncMode()) { - if (TextUtils.equals(item.getTitle(), getString(R.string.menu_sync))) { + if (isSyncMode()) {//同步 + if (TextUtils.equals(item.getTitle(), getString(R.string.menu_sync))) {//如果项目title与菜单同步相同，则进行同步 GTaskSyncService.startSync(this); } else { GTaskSyncService.cancelSync(this); } - } else { + } else {//如果不是同步模式，则开始设置动作 startPreferenceActivity(); } break; @@ -819,23 +826,24 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } @Override - public boolean onSearchRequested() { + public boolean onSearchRequested() {//根据关键字搜索便签（还未实现） startSearch(null, false, null /* appData */, false); return true; } - private void exportNoteToText() { - final BackupUtils backup = BackupUtils.getInstance(NotesListActivity.this); + 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) { + 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)); @@ -843,7 +851,8 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt .getString(R.string.error_sdcard_unmounted)); builder.setPositiveButton(android.R.string.ok, null); builder.show(); - } else if (result == BackupUtils.STATE_SUCCESS) { + } 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)); @@ -852,7 +861,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt .getExportedTextFileName(), backup.getExportedTextFileDir())); builder.setPositiveButton(android.R.string.ok, null); builder.show(); - } else if (result == BackupUtils.STATE_SYSTEM_ERROR) { + } 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)); @@ -866,20 +875,20 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt }.execute(); } - private boolean isSyncMode() { + private boolean isSyncMode() {//判断是否处于同步模式 return NotesPreferenceActivity.getSyncAccountName(this).trim().length() > 0; } - private void startPreferenceActivity() { - Activity from = getParent() != null ? getParent() : this; + 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 { + private class OnListItemClickListener implements OnItemClickListener {//响应选项的监听器 - public void onItemClick(AdapterView parent, View view, int position, long id) { - if (view instanceof NotesListItem) { + 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) { @@ -890,7 +899,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt return; } - switch (mState) { + switch (mState) {//根据状态作出不同动作，如果是便签列表，则根据项的类型分别打开文件或者控制器；如果是子文件并且是数据库并且是便签类型则打开控制器，否则报错 case NOTE_LIST: if (item.getType() == Notes.TYPE_FOLDER || item.getType() == Notes.TYPE_SYSTEM) { @@ -917,7 +926,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } - private void startQueryDestinationFolders() { + 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 + ")"; @@ -927,7 +936,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt Notes.CONTENT_NOTE_URI, FoldersListAdapter.PROJECTION, selection, - new String[] { + new String[] {//新建字符列表 String.valueOf(Notes.TYPE_FOLDER), String.valueOf(Notes.ID_TRASH_FOLER), String.valueOf(mCurrentFolderId) @@ -936,6 +945,7 @@ public class NotesListActivity extends Activity implements OnClickListener, OnIt } 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()) { diff --git a/src/main/java/net/micode/notes/widget/NoteWidgetProvider.java b/src/main/java/net/micode/notes/widget/NoteWidgetProvider.java index ec6f819..a133555 100644 --- a/src/main/java/net/micode/notes/widget/NoteWidgetProvider.java +++ b/src/main/java/net/micode/notes/widget/NoteWidgetProvider.java @@ -33,23 +33,26 @@ import net.micode.notes.ui.NoteEditActivity; import net.micode.notes.ui.NotesListActivity; public abstract class NoteWidgetProvider extends AppWidgetProvider { - public static final String [] PROJECTION = new String [] { + //note小部件类继承app小部件类且为抽象类待继承 + public static final String [] PROJECTION = new String [] {//设置便签挂饰数据的表头 NoteColumns.ID, NoteColumns.BG_COLOR_ID, - NoteColumns.SNIPPET + 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"; + 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); + 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 + "=?", @@ -58,6 +61,7 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider { } private Cursor getNoteWidgetInfo(Context context, int widgetId) { + //得到NoteWidget信息 return context.getContentResolver().query(Notes.CONTENT_NOTE_URI, PROJECTION, NoteColumns.WIDGET_ID + "=? AND " + NoteColumns.PARENT_ID + "<>?", @@ -66,23 +70,26 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider { } 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) { - for (int i = 0; i < appWidgetIds.length; i++) { - if (appWidgetIds[i] != AppWidgetManager.INVALID_APPWIDGET_ID) { + //更新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 intent = new Intent(context, NoteEditActivity.class);//创建Intent对象以用于Activity之间传递参数 intent.setFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP); - intent.putExtra(Notes.INTENT_EXTRA_WIDGET_ID, appWidgetIds[i]); - intent.putExtra(Notes.INTENT_EXTRA_WIDGET_TYPE, getWidgetType()); + 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; @@ -90,43 +97,47 @@ public abstract class NoteWidgetProvider extends AppWidgetProvider { snippet = c.getString(COLUMN_SNIPPET); bgId = c.getInt(COLUMN_BG_COLOR_ID); intent.putExtra(Intent.EXTRA_UID, c.getLong(COLUMN_ID)); - intent.setAction(Intent.ACTION_VIEW); + intent.setAction(Intent.ACTION_VIEW);//为intent设置一个行为 } else { + ////若无关联内容则新建便签 snippet = context.getResources().getString(R.string.widget_havenot_content); - intent.setAction(Intent.ACTION_INSERT_OR_EDIT); + intent.setAction(Intent.ACTION_INSERT_OR_EDIT);//为intent设置一个行为 } if (c != null) { - c.close(); + 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); + rv.setOnClickPendingIntent(R.id.widget_text, pendingIntent);//窗口服务部件 + appWidgetManager.updateAppWidget(appWidgetIds[i], rv);//更新widget的信息 } } } - protected abstract int getBgResourceId(int bgId); + protected abstract int getBgResourceId(int bgId);//从背景资源中获取当前应用ID - protected abstract int getLayoutId(); + protected abstract int getLayoutId();//获取布局ID - protected abstract int getWidgetType(); + protected abstract int getWidgetType();//获取widget类型 } diff --git a/src/main/java/net/micode/notes/widget/NoteWidgetProvider_2x.java b/src/main/java/net/micode/notes/widget/NoteWidgetProvider_2x.java index adcb2f7..945574c 100644 --- a/src/main/java/net/micode/notes/widget/NoteWidgetProvider_2x.java +++ b/src/main/java/net/micode/notes/widget/NoteWidgetProvider_2x.java @@ -25,22 +25,22 @@ import net.micode.notes.tool.ResourceParser; public class NoteWidgetProvider_2x extends NoteWidgetProvider { - @Override + //2*2窗口大小 public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { super.update(context, appWidgetManager, appWidgetIds); } - @Override + //获取布局id protected int getLayoutId() { return R.layout.widget_2x; } - @Override + //获取背景资源id protected int getBgResourceId(int bgId) { return ResourceParser.WidgetBgResources.getWidget2xBgResource(bgId); } - @Override + //获取窗口类型id protected int getWidgetType() { return Notes.TYPE_WIDGET_2X; } diff --git a/src/main/java/net/micode/notes/widget/NoteWidgetProvider_4x.java b/src/main/java/net/micode/notes/widget/NoteWidgetProvider_4x.java index c12a02e..1b516b6 100644 --- a/src/main/java/net/micode/notes/widget/NoteWidgetProvider_4x.java +++ b/src/main/java/net/micode/notes/widget/NoteWidgetProvider_4x.java @@ -25,21 +25,21 @@ import net.micode.notes.tool.ResourceParser; public class NoteWidgetProvider_4x extends NoteWidgetProvider { - @Override + //4*4窗口大小 public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { super.update(context, appWidgetManager, appWidgetIds); } - + //获取布局信息 protected int getLayoutId() { return R.layout.widget_4x; } - @Override + //获取背景资源信息 protected int getBgResourceId(int bgId) { return ResourceParser.WidgetBgResources.getWidget4xBgResource(bgId); } - @Override + //获取窗口类型信息 protected int getWidgetType() { return Notes.TYPE_WIDGET_4X; }