提交1

src/net/micode/notes/ui/NoteEditText.java

@@ -14,38 +14,44 @@
  * limitations under the License.
  */
 
-package net.micode.notes.ui;
+ package net.micode.notes.ui;
-
+
-import android.content.Context;
+ import android.content.Context;
-import android.graphics.Rect;
+ import android.graphics.Rect;
-import android.text.Layout;
+ import android.text.Layout;
-import android.text.Selection;
+ import android.text.Selection;
-import android.text.Spanned;
+ import android.text.Spanned;
-import android.text.TextUtils;
+ import android.text.TextUtils;
-import android.text.style.URLSpan;
+ import android.text.style.URLSpan;
-import android.util.AttributeSet;
+ import android.util.AttributeSet;
-import android.util.Log;
+ import android.util.Log;
-import android.view.ContextMenu;
+ import android.view.ContextMenu;
-import android.view.KeyEvent;
+ import android.view.KeyEvent;
-import android.view.MenuItem;
+ import android.view.MenuItem;
-import android.view.MenuItem.OnMenuItemClickListener;
+ import android.view.MenuItem.OnMenuItemClickListener;
-import android.view.MotionEvent;
+ import android.view.MotionEvent;
-import android.widget.EditText;
+ import android.widget.EditText;
-
+ 
-import net.micode.notes.R;
+ import net.micode.notes.R;
-
+ 
-import java.util.HashMap;
+ import java.util.HashMap;
-import java.util.Map;
+ import java.util.Map;
-
+ 
-public class NoteEditText extends EditText {
+ /**
+  * 自定义EditText组件，用于小米便签应用中的文本编辑功能
+  * 支持链接识别、回车键和删除键的特殊处理以及上下文菜单定制
+  */
+ public class NoteEditText extends EditText {
      private static final String TAG = "NoteEditText";
-    private int mIndex;
+     private int mIndex; // 当前编辑框在便签中的索引位置
-    private int mSelectionStartBeforeDelete;
+     private int mSelectionStartBeforeDelete; // 删除操作前的光标位置
  
+     // 支持的链接协议
      private static final String SCHEME_TEL = "tel:" ;
      private static final String SCHEME_HTTP = "http:" ;
      private static final String SCHEME_EMAIL = "mailto:" ;
  
+     // 协议与菜单项资源ID的映射
      private static final Map<String, Integer> sSchemaActionResMap = new HashMap<String, Integer>();
      static {
          sSchemaActionResMap.put(SCHEME_TEL, R.string.note_link_tel);
@@ -54,56 +60,89 @@ public class NoteEditText extends EditText {
      }
  
      /**
-     * Call by the {@link NoteEditActivity} to delete or add edit text
+      * 文本视图变化监听器接口
+      * 用于与NoteEditActivity通信，处理编辑框的添加、删除和文本变化事件
       */
      public interface OnTextViewChangeListener {
          /**
-         * Delete current edit text when {@link KeyEvent#KEYCODE_DEL} happens
+          * 当按下删除键且文本为空时，删除当前编辑框
-         * and the text is null
+          * @param index 当前编辑框的索引
+          * @param text 当前编辑框的文本内容
           */
          void onEditTextDelete(int index, String text);
  
          /**
-         * Add edit text after current edit text when {@link KeyEvent#KEYCODE_ENTER}
+          * 当按下回车键时，在当前编辑框后添加新的编辑框
-         * happen
+          * @param index 新编辑框的索引位置
+          * @param text 当前编辑框中回车键后的剩余文本
           */
          void onEditTextEnter(int index, String text);
  
          /**
-         * Hide or show item option when text change
+          * 当文本内容变化时，隐藏或显示菜单项
+          * @param index 当前编辑框的索引
+          * @param hasText 是否有文本内容
           */
          void onTextChange(int index, boolean hasText);
      }
  
-    private OnTextViewChangeListener mOnTextViewChangeListener;
+     private OnTextViewChangeListener mOnTextViewChangeListener; // 文本变化监听器
  
+     /**
+      * 构造函数，用于在代码中创建NoteEditText实例
+      * @param context 应用上下文
+      */
      public NoteEditText(Context context) {
          super(context, null);
          mIndex = 0;
      }
  
+     /**
+      * 设置编辑框的索引位置
+      * @param index 索引值
+      */
      public void setIndex(int index) {
          mIndex = index;
      }
  
+     /**
+      * 设置文本变化监听器
+      * @param listener 实现了OnTextViewChangeListener接口的监听器
+      */
      public void setOnTextViewChangeListener(OnTextViewChangeListener listener) {
          mOnTextViewChangeListener = listener;
      }
  
+     /**
+      * 构造函数，用于在XML布局文件中创建NoteEditText实例
+      * @param context 应用上下文
+      * @param attrs 属性集合
+      */
      public NoteEditText(Context context, AttributeSet attrs) {
          super(context, attrs, android.R.attr.editTextStyle);
      }
  
+     /**
+      * 构造函数，使用指定的样式资源
+      * @param context 应用上下文
+      * @param attrs 属性集合
+      * @param defStyle 样式资源ID
+      */
      public NoteEditText(Context context, AttributeSet attrs, int defStyle) {
          super(context, attrs, defStyle);
          // TODO Auto-generated constructor stub
      }
  
+     /**
+      * 处理触摸事件，确保点击位置能正确定位到文本
+      * @param event 触摸事件
+      * @return 是否处理了该事件
+      */
      @Override
      public boolean onTouchEvent(MotionEvent event) {
          switch (event.getAction()) {
              case MotionEvent.ACTION_DOWN:
-
+                 // 计算触摸点在文本中的位置并设置光标
                  int x = (int) event.getX();
                  int y = (int) event.getY();
                  x -= getTotalPaddingLeft();
@@ -121,15 +160,23 @@ public class NoteEditText extends EditText {
          return super.onTouchEvent(event);
      }
  
+     /**
+      * 处理按键按下事件
+      * @param keyCode 按键码
+      * @param event 按键事件
+      * @return 是否处理了该事件
+      */
      @Override
      public boolean onKeyDown(int keyCode, KeyEvent event) {
          switch (keyCode) {
              case KeyEvent.KEYCODE_ENTER:
+                 // 如果设置了监听器，让监听器处理回车键事件
                  if (mOnTextViewChangeListener != null) {
                      return false;
                  }
                  break;
              case KeyEvent.KEYCODE_DEL:
+                 // 记录删除操作前的光标位置
                  mSelectionStartBeforeDelete = getSelectionStart();
                  break;
              default:
@@ -138,10 +185,17 @@ public class NoteEditText extends EditText {
          return super.onKeyDown(keyCode, event);
      }
  
+     /**
+      * 处理按键释放事件
+      * @param keyCode 按键码
+      * @param event 按键事件
+      * @return 是否处理了该事件
+      */
      @Override
      public boolean onKeyUp(int keyCode, KeyEvent event) {
          switch(keyCode) {
              case KeyEvent.KEYCODE_DEL:
+                 // 处理删除键事件：如果光标在文本开头且不是第一个编辑框，则删除当前编辑框
                  if (mOnTextViewChangeListener != null) {
                      if (0 == mSelectionStartBeforeDelete && mIndex != 0) {
                          mOnTextViewChangeListener.onEditTextDelete(mIndex, getText().toString());
@@ -152,6 +206,7 @@ public class NoteEditText extends EditText {
                  }
                  break;
              case KeyEvent.KEYCODE_ENTER:
+                 // 处理回车键事件：将文本分割并在当前编辑框后添加新的编辑框
                  if (mOnTextViewChangeListener != null) {
                      int selectionStart = getSelectionStart();
                      String text = getText().subSequence(selectionStart, length()).toString();
@@ -167,8 +222,15 @@ public class NoteEditText extends EditText {
          return super.onKeyUp(keyCode, event);
      }
  
+     /**
+      * 焦点变化时的回调方法
+      * @param focused 是否获得焦点
+      * @param direction 焦点移动方向
+      * @param previouslyFocusedRect 之前焦点所在的矩形区域
+      */
      @Override
      protected void onFocusChanged(boolean focused, int direction, Rect previouslyFocusedRect) {
+         // 通知监听器文本内容状态变化
          if (mOnTextViewChangeListener != null) {
              if (!focused && TextUtils.isEmpty(getText())) {
                  mOnTextViewChangeListener.onTextChange(mIndex, false);
@@ -179,8 +241,13 @@ public class NoteEditText extends EditText {
          super.onFocusChanged(focused, direction, previouslyFocusedRect);
      }
  
+     /**
+      * 创建上下文菜单时的回调方法
+      * @param menu 上下文菜单
+      */
      @Override
      protected void onCreateContextMenu(ContextMenu menu) {
+         // 检查选中文本中是否包含链接，如果包含则添加对应的菜单项
          if (getText() instanceof Spanned) {
              int selStart = getSelectionStart();
              int selEnd = getSelectionEnd();
@@ -191,6 +258,7 @@ public class NoteEditText extends EditText {
              final URLSpan[] urls = ((Spanned) getText()).getSpans(min, max, URLSpan.class);
              if (urls.length == 1) {
                  int defaultResId = 0;
+                 // 根据链接协议选择对应的菜单项文本
                  for(String schema: sSchemaActionResMap.keySet()) {
                      if(urls[0].getURL().indexOf(schema) >= 0) {
                          defaultResId = sSchemaActionResMap.get(schema);
@@ -202,10 +270,11 @@ public class NoteEditText extends EditText {
                      defaultResId = R.string.note_link_other;
                  }
  
+                 // 添加菜单项并设置点击事件
                  menu.add(0, 0, 0, defaultResId).setOnMenuItemClickListener(
                          new OnMenuItemClickListener() {
                              public boolean onMenuItemClick(MenuItem item) {
-                                // goto a new intent
+                                 // 打开链接
                                  urls[0].onClick(NoteEditText.this);
                                  return true;
                              }
@@ -214,4 +283,4 @@ public class NoteEditText extends EditText {
          }
          super.onCreateContextMenu(menu);
      }
-}
+ }