张鹏展增加注释

zjh
张鹏展 8 months ago
parent fa4463b772
commit dc8ac4e874

@ -1,17 +1,18 @@
```java
/*
* Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* Apache License, Version 2.0
* 使
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*
*
*/
package net.micode.notes.tool;
@ -35,12 +36,13 @@ import java.io.FileOutputStream;
import java.io.IOException;
import java.io.PrintStream;
// 备份工具类,用于将笔记数据备份到文本文件中。
public class BackupUtils {
private static final String TAG = "BackupUtils";
// Singleton stuff
// 单例模式
private static BackupUtils sInstance;
// 获取BackupUtils的单例如果不存在则创建。
public static synchronized BackupUtils getInstance(Context context) {
if (sInstance == null) {
sInstance = new BackupUtils(context);
@ -49,43 +51,49 @@ public class BackupUtils {
}
/**
* Following states are signs to represents backup or restore
* status
*
*/
// Currently, the sdcard is not mounted
public static final int STATE_SD_CARD_UNMOUONTED = 0;
// The backup file not exist
public static final int STATE_BACKUP_FILE_NOT_EXIST = 1;
// The data is not well formated, may be changed by other programs
public static final int STATE_DATA_DESTROIED = 2;
// Some run-time exception which causes restore or backup fails
public static final int STATE_SYSTEM_ERROR = 3;
// Backup or restore success
public static final int STATE_SUCCESS = 4;
// SD卡未挂载
public static final int STATE_SD_CARD_UNMOUONTED = 0;
// 备份文件不存在
public static final int STATE_BACKUP_FILE_NOT_EXIST = 1;
// 数据格式不正确,可能被其他程序更改
public static final int STATE_DATA_DESTROIED = 2;
// 运行时异常导致备份或恢复失败
public static final int STATE_SYSTEM_ERROR = 3;
// 备份或恢复成功
public static final int STATE_SUCCESS = 4;
private TextExport mTextExport;
// 私有构造函数用于创建BackupUtils实例。
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 {
// 笔记数据投影数组。
private static final String[] NOTE_PROJECTION = {
NoteColumns.ID,
NoteColumns.MODIFIED_DATE,
@ -93,12 +101,12 @@ public class BackupUtils {
NoteColumns.TYPE
};
// 数据列索引。
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,
@ -108,23 +116,25 @@ public class BackupUtils {
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 final String[] TEXT_FORMAT;
private static final int FORMAT_FOLDER_NAME = 0;
private static final int FORMAT_NOTE_DATE = 1;
private static final int FORMAT_NOTE_CONTENT = 2;
// 上下文对象,用于访问资源和内容解析器。
private Context mContext;
// 导出文件的名称和目录。
private String mFileName;
private String mFileDirectory;
// 构造函数,初始化上下文和格式数组。
public TextExport(Context context) {
TEXT_FORMAT = context.getResources().getStringArray(R.array.format_for_exported_note);
mContext = context;
@ -132,28 +142,29 @@ public class BackupUtils {
mFileDirectory = "";
}
// 根据ID获取对应的格式字符串。
private String getFormat(int id) {
return TEXT_FORMAT[id];
}
/**
* Export the folder identified by folder id to text
* ID
*/
private void exportFolderToText(String folderId, PrintStream ps) {
// Query notes belong to this folder
// 查询属于该文件夹的笔记。
Cursor notesCursor = mContext.getContentResolver().query(Notes.CONTENT_NOTE_URI,
NOTE_PROJECTION, NoteColumns.PARENT_ID + "=?", new String[] {
folderId
folderId
}, null);
if (notesCursor != null) {
if (notesCursor.moveToFirst()) {
do {
// Print note's last modified date
// 打印笔记最后修改日期。
ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format(
mContext.getString(R.string.format_datetime_mdhm),
notesCursor.getLong(NOTE_COLUMN_MODIFIED_DATE))));
// Query data belong to this note
// 查询属于该笔记的数据。
String noteId = notesCursor.getString(NOTE_COLUMN_ID);
exportNoteToText(noteId, ps);
} while (notesCursor.moveToNext());
@ -163,12 +174,12 @@ public class BackupUtils {
}
/**
* Export note identified by id to a print stream
* ID
*/
private void exportNoteToText(String noteId, PrintStream ps) {
Cursor dataCursor = mContext.getContentResolver().query(Notes.CONTENT_DATA_URI,
DATA_PROJECTION, DataColumns.NOTE_ID + "=?", new String[] {
noteId
noteId
}, null);
if (dataCursor != null) {
@ -176,7 +187,7 @@ public class BackupUtils {
do {
String mimeType = dataCursor.getString(DATA_COLUMN_MIME_TYPE);
if (DataConstants.CALL_NOTE.equals(mimeType)) {
// Print phone number
// 打印电话号码
String phoneNumber = dataCursor.getString(DATA_COLUMN_PHONE_NUMBER);
long callDate = dataCursor.getLong(DATA_COLUMN_CALL_DATE);
String location = dataCursor.getString(DATA_COLUMN_CONTENT);
@ -185,11 +196,11 @@ public class BackupUtils {
ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT),
phoneNumber));
}
// Print call date
// 打印通话日期
ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT), DateFormat
.format(mContext.getString(R.string.format_datetime_mdhm),
callDate)));
// Print call attachment location
// 打印通话附件位置
if (!TextUtils.isEmpty(location)) {
ps.println(String.format(getFormat(FORMAT_NOTE_CONTENT),
location));
@ -205,7 +216,7 @@ public class BackupUtils {
}
dataCursor.close();
}
// print a line separator between note
// 打印笔记之间的分隔线。
try {
ps.write(new byte[] {
Character.LINE_SEPARATOR, Character.LETTER_NUMBER
@ -216,33 +227,34 @@ public class BackupUtils {
}
/**
* Note will be exported as text which is user readable
*
*/
public int exportToText() {
if (!externalStorageAvailable()) {
Log.d(TAG, "Media was not mounted");
Log.d(TAG, "媒体未挂载");
return STATE_SD_CARD_UNMOUONTED;
}
PrintStream ps = getExportToTextPrintStream();
if (ps == null) {
Log.e(TAG, "get print stream error");
Log.e(TAG, "获取打印流出错");
return STATE_SYSTEM_ERROR;
}
// First export folder and its notes
// 首先导出文件夹及其笔记。
Cursor folderCursor = mContext.getContentResolver().query(
Notes.CONTENT_NOTE_URI,
NOTE_PROJECTION,
"(" + NoteColumns.TYPE + "=" + Notes.TYPE_FOLDER + " AND "
+ NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER + ") OR "
+ NoteColumns.ID + "=" + Notes.ID_CALL_RECORD_FOLDER, null, null);
+ NoteColumns.ID + "=" + Notes.ID_CALL_RECORD_FOLDER,
null, null);
if (folderCursor != null) {
if (folderCursor.moveToFirst()) {
do {
// Print folder's name
// 打印文件夹名称
String folderName = "";
if(folderCursor.getLong(NOTE_COLUMN_ID) == Notes.ID_CALL_RECORD_FOLDER) {
if (folderCursor.getLong(NOTE_COLUMN_ID) == Notes.ID_CALL_RECORD_FOLDER) {
folderName = mContext.getString(R.string.call_record_folder_name);
} else {
folderName = folderCursor.getString(NOTE_COLUMN_SNIPPET);
@ -257,20 +269,21 @@ public class BackupUtils {
folderCursor.close();
}
// Export notes in root's folder
// 导出根文件夹中的笔记。
// 导出根文件夹中的笔记
Cursor noteCursor = mContext.getContentResolver().query(
Notes.CONTENT_NOTE_URI,
NOTE_PROJECTION,
NoteColumns.TYPE + "=" + +Notes.TYPE_NOTE + " AND " + NoteColumns.PARENT_ID
+ "=0", null, null);
NoteColumns.TYPE + "=" + Notes.TYPE_NOTE + " AND " + NoteColumns.PARENT_ID + "=0", null, null);
if (noteCursor != null) {
if (noteCursor.moveToFirst()) {
do {
// 打印笔记最后修改日期
ps.println(String.format(getFormat(FORMAT_NOTE_DATE), DateFormat.format(
mContext.getString(R.string.format_datetime_mdhm),
noteCursor.getLong(NOTE_COLUMN_MODIFIED_DATE))));
// Query data belong to this note
// 查询属于这条笔记的数据
String noteId = noteCursor.getString(NOTE_COLUMN_ID);
exportNoteToText(noteId, ps);
} while (noteCursor.moveToNext());
@ -279,17 +292,19 @@ public class BackupUtils {
}
ps.close();
// 返回成功状态码
return STATE_SUCCESS;
}
/**
* Get a print stream pointed to the file {@generateExportedTextFile}
*
*/
private PrintStream getExportToTextPrintStream() {
// 生成存储导出数据的文本文件
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, "创建导出文件失败");
return null;
}
mFileName = file.getName();
@ -309,36 +324,33 @@ public class BackupUtils {
}
}
/**
* 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(context.getString(
fileNameFormatResId,
DateFormat.format(context.getString(R.string.format_date_ymd),
System.currentTimeMillis())));
File file = new File(sb.toString());
try {
if (!filedir.exists()) {
filedir.mkdir();
}
if (!file.exists()) {
file.createNewFile();
}
return file;
} catch (SecurityException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
/**
* SD
*/
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(context.getString(
fileNameFormatResId,
DateFormat.format(context.getString(R.string.format_date_ymd),
System.currentTimeMillis())));
File file = new File(sb.toString());
try {
if (!filedir.exists()) {
filedir.mkdir();
}
return null;
if (!file.exists()) {
file.createNewFile();
}
return file;
} catch (SecurityException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
return null;
}

@ -1,17 +1,16 @@
/*
* Copyright (c) 2010-2011, The MiCode Open Source Community (www.micode.net)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* Apache License, Version 2.0
* 使
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*
*
*/
package net.micode.notes.tool;
@ -34,23 +33,25 @@ import net.micode.notes.ui.NotesListAdapter.AppWidgetAttribute;
import java.util.ArrayList;
import java.util.HashSet;
// 数据工具类,提供对笔记数据的操作函数
public class DataUtils {
public static final String TAG = "DataUtils";
// 批量删除笔记
public static boolean batchDeleteNotes(ContentResolver resolver, HashSet<Long> ids) {
if (ids == null) {
Log.d(TAG, "the ids is null");
Log.d(TAG, "id集合为空");
return true;
}
if (ids.size() == 0) {
Log.d(TAG, "no id is in the hashset");
Log.d(TAG, "id集合中没有元素");
return true;
}
ArrayList<ContentProviderOperation> operationList = new ArrayList<ContentProviderOperation>();
for (long id : ids) {
if(id == Notes.ID_ROOT_FOLDER) {
Log.e(TAG, "Don't delete system folder root");
if (id == Notes.ID_ROOT_FOLDER) {
Log.e(TAG, "不要删除系统根文件夹");
continue;
}
ContentProviderOperation.Builder builder = ContentProviderOperation
@ -60,7 +61,7 @@ public class DataUtils {
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, "删除笔记失败, ids:" + ids.toString());
return false;
}
return true;
@ -72,6 +73,7 @@ public class DataUtils {
return false;
}
// 将笔记移动到指定文件夹
public static void moveNoteToFoler(ContentResolver resolver, long id, long srcFolderId, long desFolderId) {
ContentValues values = new ContentValues();
values.put(NoteColumns.PARENT_ID, desFolderId);
@ -80,10 +82,11 @@ public class DataUtils {
resolver.update(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, id), values, null, null);
}
// 批量将笔记移动到指定文件夹
public static boolean batchMoveToFolder(ContentResolver resolver, HashSet<Long> ids,
long folderId) {
if (ids == null) {
Log.d(TAG, "the ids is null");
Log.d(TAG, "id集合为空");
return true;
}
@ -99,7 +102,7 @@ public class DataUtils {
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, "移动笔记失败, ids:" + ids.toString());
return false;
}
return true;
@ -112,22 +115,22 @@ public class DataUtils {
}
/**
* 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,
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)},
new String[] { String.valueOf(Notes.TYPE_FOLDER), String.valueOf(Notes.ID_TRASH_FOLER) },
null);
int count = 0;
if(cursor != null) {
if(cursor.moveToFirst()) {
if (cursor != null) {
if (cursor.moveToFirst()) {
try {
count = cursor.getInt(0);
} catch (IndexOutOfBoundsException e) {
Log.e(TAG, "get folder count failed:" + e.toString());
Log.e(TAG, "获取文件夹数量失败:" + e.toString());
} finally {
cursor.close();
}
@ -136,11 +139,12 @@ public class DataUtils {
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)},
new String[] { String.valueOf(type) },
null);
boolean exist = false;
@ -153,6 +157,7 @@ public class DataUtils {
return exist;
}
// 检查笔记在数据库中是否存在
public static boolean existInNoteDatabase(ContentResolver resolver, long noteId) {
Cursor cursor = resolver.query(ContentUris.withAppendedId(Notes.CONTENT_NOTE_URI, noteId),
null, null, null, null);
@ -167,6 +172,7 @@ public class DataUtils {
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);
@ -181,15 +187,16 @@ public class DataUtils {
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 + "=?",
" AND " + NoteColumns.PARENT_ID + "<>" + Notes.ID_TRASH_FOLER +
" AND " + NoteColumns.SNIPPET + "=?",
new String[] { name }, null);
boolean exist = false;
if(cursor != null) {
if(cursor.getCount() > 0) {
if (cursor != null) {
if (cursor.getCount() > 0) {
exist = true;
}
cursor.close();
@ -197,6 +204,7 @@ public class DataUtils {
return exist;
}
// 获取文件夹笔记的小部件属性
public static HashSet<AppWidgetAttribute> getFolderNoteWidget(ContentResolver resolver, long folderId) {
Cursor c = resolver.query(Notes.CONTENT_NOTE_URI,
new String[] { NoteColumns.WIDGET_ID, NoteColumns.WIDGET_TYPE },
@ -224,72 +232,82 @@ public class DataUtils {
return set;
}
// 根据笔记ID获取通话号码
public static String getCallNumberByNoteId(ContentResolver resolver, long 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);
Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI,
new String [] { CallNote.PHONE_NUMBER },
CallNote.NOTE_ID + "=? AND " + CallNote.MIME_TYPE + "=?",
new String [] { String.valueOf(noteId), CallNote.CONTENT_ITEM_TYPE },
null);
// 如果游标不为空并且移动到第一行,则尝试获取通话号码
if (cursor != null && cursor.moveToFirst()) {
try {
return cursor.getString(0);
return cursor.getString(0); // 返回获取到的字符串
} catch (IndexOutOfBoundsException e) {
Log.e(TAG, "Get call number fails " + e.toString());
Log.e(TAG, "获取通话号码失败:" + e.toString()); // 记录异常信息
} finally {
cursor.close();
cursor.close(); // 确保游标被关闭
}
}
return "";
}
return ""; // 如果失败,返回空字符串
// 根据电话号码和通话日期获取笔记ID
public static long getNoteIdByPhoneNumberAndCallDate(ContentResolver resolver, String phoneNumber, long callDate) {
Cursor cursor = resolver.query(Notes.CONTENT_DATA_URI,
new String [] { CallNote.NOTE_ID },
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 },
+ CallNote.PHONE_NUMBER + ",?)",
new String[] { String.valueOf(callDate), CallNote.CONTENT_ITEM_TYPE, phoneNumber },
null);
// 如果游标不为空并且移动到第一行则尝试获取笔记ID
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, "获取通话笔记ID失败" + e.toString()); // 记录异常信息
}
}
cursor.close();
cursor.close(); // 确保游标被关闭
}
return 0;
return 0; // 如果失败返回0
}
// 根据笔记ID获取摘要
public static String getSnippetById(ContentResolver resolver, long noteId) {
Cursor cursor = resolver.query(Notes.CONTENT_NOTE_URI,
new String [] { NoteColumns.SNIPPET },
new String[] { NoteColumns.SNIPPET },
NoteColumns.ID + "=?",
new String [] { String.valueOf(noteId)},
new String[] { String.valueOf(noteId) },
null);
// 如果游标不为空并且移动到第一行,则尝试获取摘要
if (cursor != null) {
String snippet = "";
if (cursor.moveToFirst()) {
snippet = cursor.getString(0);
snippet = cursor.getString(0); // 获取摘要
}
cursor.close();
return snippet;
cursor.close(); // 确保游标被关闭
return snippet; // 返回摘要
}
throw new IllegalArgumentException("Note is not found with id: " + noteId);
throw new IllegalArgumentException("未找到ID为" + noteId + "的笔记"); // 如果失败,抛出异常
}
// 获取格式化后的摘要
public static String getFormattedSnippet(String snippet) {
if (snippet != null) {
snippet = snippet.trim();
int index = snippet.indexOf('\n');
snippet = snippet.trim(); // 去除首尾空白
int index = snippet.indexOf('\n'); // 查找换行符
if (index != -1) {
snippet = snippet.substring(0, index);
snippet = snippet.substring(0, index); // 截取换行符之前的字符串
}
}
return snippet;
return snippet; // 返回格式化后的摘要
}
}

@ -16,98 +16,145 @@
package net.micode.notes.tool;
// GTaskStringUtils类主要用于定义一些与Google Tasks相关操作中使用的字符串常量方便在代码中统一引用和管理
public class GTaskStringUtils {
// 表示操作的唯一ID的JSON键名用于在与Google Tasks交互的JSON数据中标识某个具体操作的ID
public final static String GTASK_JSON_ACTION_ID = "action_id";
// 表示操作列表的JSON键名用于在与Google Tasks交互的JSON数据中存放一组操作的集合通常是一个JSON数组
public final static String GTASK_JSON_ACTION_LIST = "action_list";
// 表示操作类型的JSON键名用于在与Google Tasks交互的JSON数据中指定某个操作具体是什么类型的操作比如创建、获取、移动等
public final static String GTASK_JSON_ACTION_TYPE = "action_type";
// 表示创建操作类型的具体值,对应创建相关的操作,例如创建任务、创建任务列表等操作时使用该值来标识操作类型
public final static String GTASK_JSON_ACTION_TYPE_CREATE = "create";
// 表示获取所有(任务等)操作类型的具体值,用于获取某个任务列表下的所有任务等情况时标识操作类型
public final static String GTASK_JSON_ACTION_TYPE_GETALL = "get_all";
// 表示移动操作类型的具体值,用于在移动任务、任务列表等位置时标识操作类型
public final static String GTASK_JSON_ACTION_TYPE_MOVE = "move";
// 表示更新操作类型的具体值,用于对任务、任务列表等进行更新操作时标识操作类型
public final static String GTASK_JSON_ACTION_TYPE_UPDATE = "update";
// 表示创建者ID的JSON键名用于在与Google Tasks交互的JSON数据中存放创建某个任务、任务列表等的用户ID信息
public final static String GTASK_JSON_CREATOR_ID = "creator_id";
// 表示子实体的JSON键名可能用于在涉及包含子元素的结构如任务列表包含多个任务等情况标识子实体相关信息
public final static String GTASK_JSON_CHILD_ENTITY = "child_entity";
// 表示客户端版本号的JSON键名用于在与Google Tasks交互的JSON数据中告知服务器当前客户端的版本信息便于进行兼容性等相关处理
public final static String GTASK_JSON_CLIENT_VERSION = "client_version";
// 表示是否完成的JSON键名可能用于任务等实体中标识该任务是否已经完成的状态信息
public final static String GTASK_JSON_COMPLETED = "completed";
// 表示当前列表ID的JSON键名可能用于在涉及多列表切换、关联等场景时标识当前所在的任务列表的ID
public final static String GTASK_JSON_CURRENT_LIST_ID = "current_list_id";
// 表示默认列表ID的JSON键名用于标识某个用户、某个应用场景下的默认任务列表的ID信息
public final static String GTASK_JSON_DEFAULT_LIST_ID = "default_list_id";
// 表示是否已删除的JSON键名用于在任务、任务列表等实体中标识其是否已经被删除的状态信息
public final static String GTASK_JSON_DELETED = "deleted";
// 表示目标列表的JSON键名在进行移动操作等涉及改变所属列表的操作时用于指定要移动到的目标任务列表的ID
public final static String GTASK_JSON_DEST_LIST = "dest_list";
// 表示目标父级的JSON键名在进行移动操作、关联操作等涉及改变父级元素的情况时用于指定要移动到或关联的目标父级元素的相关信息比如任务列表等
public final static String GTASK_JSON_DEST_PARENT = "dest_parent";
// 表示目标父级类型的JSON键名可能用于进一步明确目标父级元素的具体类型例如是任务列表类型还是其他类型等
public final static String GTASK_JSON_DEST_PARENT_TYPE = "dest_parent_type";
// 表示实体差异的JSON键名可能用于在对比、更新实体时标识实体之间发生变化的部分相关信息
public final static String GTASK_JSON_ENTITY_DELTA = "entity_delta";
// 表示实体类型的JSON键名用于在与Google Tasks交互的JSON数据中明确某个实体如任务、任务列表等具体是什么类型
public final static String GTASK_JSON_ENTITY_TYPE = "entity_type";
// 表示是否获取已删除的JSON键名在进行查询操作时用于指定是否要获取已经被标记为删除的任务、任务列表等信息
public final static String GTASK_JSON_GET_DELETED = "get_deleted";
// 表示唯一ID的JSON键名通常用于标识任务、任务列表等实体在Google Tasks系统中的全局唯一标识符
public final static String GTASK_JSON_ID = "id";
// 表示索引的JSON键名可能用于在任务列表中标识某个任务的排列顺序等索引相关信息
public final static String GTASK_JSON_INDEX = "index";
// 表示最后修改时间的JSON键名用于记录任务、任务列表等实体最后一次被修改的时间信息便于进行同步、更新等操作时的判断
public final static String GTASK_JSON_LAST_MODIFIED = "last_modified";
// 表示最新同步点的JSON键名可能用于记录与Google Tasks进行数据同步时的最新同步时间点等相关信息便于后续判断同步范围、增量等情况
public final static String GTASK_JSON_LATEST_SYNC_POINT = "latest_sync_point";
// 表示列表ID的JSON键名常用于标识某个具体的任务列表的ID信息与其他相关操作配合使用比如获取某个列表下的任务等操作
public final static String GTASK_JSON_LIST_ID = "list_id";
// 表示任务列表复数形式的JSON键名用于在与Google Tasks交互的JSON数据中存放多个任务列表信息的集合通常是一个JSON数组
public final static String GTASK_JSON_LISTS = "lists";
// 表示名称的JSON键名用于任务、任务列表等实体中存放它们的名称信息方便展示、识别等操作
public final static String GTASK_JSON_NAME = "name";
// 表示新ID的JSON键名可能在某些创建、更新操作后用于存放新生成的实体ID信息比如创建任务后返回的新任务ID等情况
public final static String GTASK_JSON_NEW_ID = "new_id";
// 表示备注笔记的JSON键名可能用于存放与任务相关的一些备注、说明等文本信息
public final static String GTASK_JSON_NOTES = "notes";
// 表示父级ID的JSON键名用于在任务、任务列表等实体中标识其所属的父级元素的ID信息建立层级关系
public final static String GTASK_JSON_PARENT_ID = "parent_id";
// 表示前一个兄弟节点任务等ID的JSON键名在任务列表中用于标识某个任务之前相邻的兄弟任务的ID常用于排序、移动等操作场景
public final static String GTASK_JSON_PRIOR_SIBLING_ID = "prior_sibling_id";
// 表示操作结果的JSON键名在执行某些操作如批量操作等用于存放操作的结果信息通常是一个JSON数组
public final static String GTASK_JSON_RESULTS = "results";
// 表示源列表的JSON键名在进行移动操作等涉及改变所属列表的操作时用于指定操作前所在的原始任务列表的ID
public final static String GTASK_JSON_SOURCE_LIST = "source_list";
// 表示任务复数形式的JSON键名用于在与Google Tasks交互的JSON数据中存放多个任务信息的集合通常是一个JSON数组
public final static String GTASK_JSON_TASKS = "tasks";
// 表示类型的JSON键名用于在与Google
// Tasks交互的JSON数据中明确某个实体如任务、任务列表等具体是什么类型和GTASK_JSON_ENTITY_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_TASK = "TASK";
// 表示用户的JSON键名可能用于存放与操作相关的用户信息比如执行操作的用户账号等情况
public final static String GTASK_JSON_USER = "user";
// MIUI系统中笔记相关的文件夹前缀字符串用于在名称等地方标识该文件夹是属于MIUI笔记应用相关的文件夹
public final static String MIUI_FOLDER_PREFFIX = "[MIUI_Notes]";
// 表示默认文件夹名称的字符串常量,用于标识默认的任务列表、文件夹等的名称
public final static String FOLDER_DEFAULT = "Default";
// 表示通话记录笔记文件夹名称的字符串常量,用于明确该文件夹是存放通话记录相关笔记的
public final static String FOLDER_CALL_NOTE = "Call_Note";
// 表示元数据文件夹名称的字符串常量,用于标识存放元数据相关内容的文件夹名称
public final static String FOLDER_META = "METADATA";
// 表示元数据中Google Tasks ID的键名可能用于在元数据结构中关联对应的Google Tasks实体的ID信息
public final static String META_HEAD_GTASK_ID = "meta_gid";
// 表示元数据中笔记相关内容的键名,用于在元数据结构中存放与笔记相关的具体信息
public final static String META_HEAD_NOTE = "meta_note";
// 表示元数据中数据相关内容的键名,用于在元数据结构中存放一些额外的数据信息(可能是和任务、笔记等相关的数据集合等情况)
public final static String META_HEAD_DATA = "meta_data";
// 表示元数据笔记名称的字符串常量,同时提示不要更新和删除该元数据笔记(可能是具有特殊用途的固定元数据相关说明)
public final static String META_NOTE_NAME = "[META INFO] DON'T UPDATE AND DELETE";
}
}

@ -14,6 +14,7 @@
* limitations under the License.
*/
// 该类所属的包名表明这个类位于net.micode.notes.tool包下用于提供一些资源相关的解析和获取功能
package net.micode.notes.tool;
import android.content.Context;
@ -22,49 +23,61 @@ import android.preference.PreferenceManager;
import net.micode.notes.R;
import net.micode.notes.ui.NotesPreferenceActivity;
// ResourceParser类主要用于对应用中的各种资源如背景图片、文本样式等进行管理和提供获取方法方便在不同的界面等场景中使用
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 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;
// 定义默认的背景颜色常量其值为黄色对应上面定义的颜色常量中的YELLOW表示在没有特殊设置时默认使用的背景颜色
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 TEXT_SMALL = 0;
public static final int TEXT_MEDIUM = 1;
public static final int TEXT_LARGE = 2;
public static final int TEXT_SUPER = 3;
// 定义默认的字体大小常量其值为中等大小对应上面定义的文本大小常量中的TEXT_MEDIUM表示在没有特殊设置时默认使用的字体大小
public static final int BG_DEFAULT_FONT_SIZE = TEXT_MEDIUM;
// 内部静态类NoteBgResources用于管理笔记编辑界面相关的背景资源图片资源
public static class NoteBgResources {
private final static int [] BG_EDIT_RESOURCES = new int [] {
R.drawable.edit_yellow,
R.drawable.edit_blue,
R.drawable.edit_white,
R.drawable.edit_green,
R.drawable.edit_red
// 定义一个私有的静态整型数组存储笔记编辑界面背景图片资源的ID对应不同颜色的编辑界面背景图片顺序与前面定义的颜色常量顺序一致
private final static int[] BG_EDIT_RESOURCES = new int[] {
R.drawable.edit_yellow,
R.drawable.edit_blue,
R.drawable.edit_white,
R.drawable.edit_green,
R.drawable.edit_red
};
private final static int [] BG_EDIT_TITLE_RESOURCES = new int [] {
R.drawable.edit_title_yellow,
R.drawable.edit_title_blue,
R.drawable.edit_title_white,
R.drawable.edit_title_green,
R.drawable.edit_title_red
// 定义一个私有的静态整型数组存储笔记编辑界面标题背景图片资源的ID对应不同颜色的编辑界面标题背景图片顺序与前面定义的颜色常量顺序一致
private final static int[] BG_EDIT_TITLE_RESOURCES = new int[] {
R.drawable.edit_title_yellow,
R.drawable.edit_title_blue,
R.drawable.edit_title_white,
R.drawable.edit_title_green,
R.drawable.edit_title_red
};
// 根据传入的颜色ID对应前面定义的颜色常量获取笔记编辑界面的背景图片资源ID方便在设置编辑界面背景时使用
public static int getNoteBgResource(int id) {
return BG_EDIT_RESOURCES[id];
}
// 根据传入的颜色ID对应前面定义的颜色常量获取笔记编辑界面标题的背景图片资源ID方便在设置编辑界面标题背景时使用
public static int getNoteTitleBgResource(int id) {
return BG_EDIT_TITLE_RESOURCES[id];
}
}
// 根据传入的上下文Context获取默认的背景图片ID逻辑是先检查是否在偏好设置中设置了自定义背景颜色通过特定的偏好设置键来判断
// 如果设置了则随机选择一个背景资源ID从NoteBgResources中定义的资源数组长度范围内随机否则返回默认的背景颜色IDBG_DEFAULT_COLOR
public static int getDefaultBgId(Context context) {
if (PreferenceManager.getDefaultSharedPreferences(context).getBoolean(
NotesPreferenceActivity.PREFERENCE_SET_BG_COLOR_KEY, false)) {
@ -74,94 +87,113 @@ public class ResourceParser {
}
}
// 内部静态类NoteItemBgResources用于管理笔记列表项相关的背景资源图片资源
public static class NoteItemBgResources {
private final static int [] BG_FIRST_RESOURCES = new int [] {
R.drawable.list_yellow_up,
R.drawable.list_blue_up,
R.drawable.list_white_up,
R.drawable.list_green_up,
R.drawable.list_red_up
// 定义一个私有的静态整型数组存储笔记列表项第一个元素可能是列表头部等情况的背景图片资源ID对应不同颜色的背景图片顺序与前面定义的颜色常量顺序一致
private final static int[] BG_FIRST_RESOURCES = new int[] {
R.drawable.list_yellow_up,
R.drawable.list_blue_up,
R.drawable.list_white_up,
R.drawable.list_green_up,
R.drawable.list_red_up
};
private final static int [] BG_NORMAL_RESOURCES = new int [] {
R.drawable.list_yellow_middle,
R.drawable.list_blue_middle,
R.drawable.list_white_middle,
R.drawable.list_green_middle,
R.drawable.list_red_middle
// 定义一个私有的静态整型数组存储笔记列表项中间元素正常的列表项情况的背景图片资源ID对应不同颜色的背景图片顺序与前面定义的颜色常量顺序一致
private final static int[] BG_NORMAL_RESOURCES = new int[] {
R.drawable.list_yellow_middle,
R.drawable.list_blue_middle,
R.drawable.list_white_middle,
R.drawable.list_green_middle,
R.drawable.list_red_middle
};
private final static int [] BG_LAST_RESOURCES = new int [] {
R.drawable.list_yellow_down,
R.drawable.list_blue_down,
R.drawable.list_white_down,
R.drawable.list_green_down,
R.drawable.list_red_down,
// 定义一个私有的静态整型数组存储笔记列表项最后一个元素可能是列表尾部等情况的背景图片资源ID对应不同颜色的背景图片顺序与前面定义的颜色常量顺序一致
private final static int[] BG_LAST_RESOURCES = new int[] {
R.drawable.list_yellow_down,
R.drawable.list_blue_down,
R.drawable.list_white_down,
R.drawable.list_green_down,
R.drawable.list_red_down,
};
private final static int [] BG_SINGLE_RESOURCES = new int [] {
R.drawable.list_yellow_single,
R.drawable.list_blue_single,
R.drawable.list_white_single,
R.drawable.list_green_single,
R.drawable.list_red_single
// 定义一个私有的静态整型数组存储单个笔记可能是独立展示等情况的背景图片资源ID对应不同颜色的背景图片顺序与前面定义的颜色常量顺序一致
private final static int[] BG_SINGLE_RESOURCES = new int[] {
R.drawable.list_yellow_single,
R.drawable.list_blue_single,
R.drawable.list_white_single,
R.drawable.list_green_single,
R.drawable.list_red_single
};
// 根据传入的颜色ID对应前面定义的颜色常量获取笔记列表项第一个元素的背景图片资源ID方便在设置列表项背景时使用
public static int getNoteBgFirstRes(int id) {
return BG_FIRST_RESOURCES[id];
}
// 根据传入的颜色ID对应前面定义的颜色常量获取笔记列表项最后一个元素的背景图片资源ID方便在设置列表项背景时使用
public static int getNoteBgLastRes(int id) {
return BG_LAST_RESOURCES[id];
}
// 根据传入的颜色ID对应前面定义的颜色常量获取单个笔记的背景图片资源ID方便在设置单个笔记背景时使用
public static int getNoteBgSingleRes(int id) {
return BG_SINGLE_RESOURCES[id];
}
// 根据传入的颜色ID对应前面定义的颜色常量获取笔记列表项中间元素正常列表项的背景图片资源ID方便在设置列表项背景时使用
public static int getNoteBgNormalRes(int id) {
return BG_NORMAL_RESOURCES[id];
}
// 获取文件夹的背景图片资源ID用于设置文件夹在列表等展示场景中的背景图片
public static int getFolderBgRes() {
return R.drawable.list_folder;
}
}
// 内部静态类WidgetBgResources用于管理桌面小部件相关的背景资源图片资源
public static class WidgetBgResources {
private final static int [] BG_2X_RESOURCES = new int [] {
R.drawable.widget_2x_yellow,
R.drawable.widget_2x_blue,
R.drawable.widget_2x_white,
R.drawable.widget_2x_green,
R.drawable.widget_2x_red,
// 定义一个私有的静态整型数组存储2x尺寸桌面小部件的背景图片资源ID对应不同颜色的背景图片顺序与前面定义的颜色常量顺序一致
private final static int[] BG_2X_RESOURCES = new int[] {
R.drawable.widget_2x_yellow,
R.drawable.widget_2x_blue,
R.drawable.widget_2x_white,
R.drawable.widget_2x_green,
R.drawable.widget_2x_red,
};
// 根据传入的颜色ID对应前面定义的颜色常量获取2x尺寸桌面小部件的背景图片资源ID方便在设置小部件背景时使用
public static int getWidget2xBgResource(int id) {
return BG_2X_RESOURCES[id];
}
private final static int [] BG_4X_RESOURCES = new int [] {
R.drawable.widget_4x_yellow,
R.drawable.widget_4x_blue,
R.drawable.widget_4x_white,
R.drawable.widget_4x_green,
R.drawable.widget_4x_red
// 定义一个私有的静态整型数组存储4x尺寸桌面小部件的背景图片资源ID对应不同颜色的背景图片顺序与前面定义的颜色常量顺序一致
private final static int[] BG_4X_RESOURCES = new int[] {
R.drawable.widget_4x_yellow,
R.drawable.widget_4x_blue,
R.drawable.widget_4x_white,
R.drawable.widget_4x_green,
R.drawable.widget_4x_red
};
// 根据传入的颜色ID对应前面定义的颜色常量获取4x尺寸桌面小部件的背景图片资源ID方便在设置小部件背景时使用
public static int getWidget4xBgResource(int id) {
return BG_4X_RESOURCES[id];
}
}
// 内部静态类TextAppearanceResources用于管理文本外观相关的资源主要是文本样式资源
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对应不同大小的文本外观样式顺序与前面定义的文本大小常量顺序有一定关联
private final static int[] TEXTAPPEARANCE_RESOURCES = new int[] {
R.style.TextAppearanceNormal,
R.style.TextAppearanceMedium,
R.style.TextAppearanceLarge,
R.style.TextAppearanceSuper
};
// 根据传入的文本外观资源ID获取对应的文本外观资源ID如果传入的ID大于资源数组的长度可能是由于存储或获取出现异常情况
// 则返回默认的字体大小对应的资源IDBG_DEFAULT_FONT_SIZE以避免出现资源获取错误
public static int getTexAppearanceResource(int id) {
/**
* HACKME: Fix bug of store the resource id in shared preference.
@ -174,8 +206,9 @@ public class ResourceParser {
return TEXTAPPEARANCE_RESOURCES[id];
}
// 获取文本外观资源数组的长度,可用于判断资源数量或者进行一些边界相关的操作判断等
public static int getResourcesSize() {
return TEXTAPPEARANCE_RESOURCES.length;
}
}
}
}
Loading…
Cancel
Save