Hide mCursorController field in ArrowKeyMovementMethod.
Made the field private and added a description of its use.
Bug http://b/issue?id=2975284
Change-Id: Id8acf756218915cb2ae756789b62cfe7201a5c67
diff --git a/core/java/android/text/method/ArrowKeyMovementMethod.java b/core/java/android/text/method/ArrowKeyMovementMethod.java
index 3fe14f9..0408673 100644
--- a/core/java/android/text/method/ArrowKeyMovementMethod.java
+++ b/core/java/android/text/method/ArrowKeyMovementMethod.java
@@ -34,7 +34,7 @@
* An optional controller for the cursor.
* Use {@link #setCursorController(CursorController)} to set this field.
*/
- protected CursorController mCursorController;
+ private CursorController mCursorController;
private boolean isCap(Spannable buffer) {
return ((MetaKeyKeyListener.getMetaState(buffer, KeyEvent.META_SHIFT_ON) == 1) ||
@@ -302,7 +302,17 @@
/**
* Defines the cursor controller.
*
- * When set, this object can be used to handle events, that can be translated in cursor updates.
+ * When set, this object can be used to handle touch events, that can be translated into cursor
+ * updates.
+ *
+ * {@link MotionEvent#ACTION_MOVE} events will call back the
+ * {@link CursorController#updatePosition(int, int)} controller's method, passing the current
+ * finger coordinates (offset by {@link CursorController#getOffsetX()} and
+ * {@link CursorController#getOffsetY()}) as parameters.
+ *
+ * When the gesture is finished (on a {@link MotionEvent#ACTION_UP} or
+ * {@link MotionEvent#ACTION_CANCEL} event), the controller is reset to null.
+ *
* @param cursorController A cursor controller implementation
*/
public void setCursorController(CursorController cursorController) {
