实现文本放大镜

尝试 Compose 方法
Jetpack Compose 是推荐的 Android UI 工具包。了解如何在 Compose 中使用文本。

放大镜小部件在 Android 9(API 级别 28)及更高版本中可用,它是一个虚拟放大镜,通过代表镜头的叠加窗格显示 View 的放大副本。此功能改进了文本插入和选择的用户体验。将放大镜应用于文本时,用户可以通过查看跟随其手指的窗格中的放大文本来精确放置光标或选择句柄。

图 1 显示了放大镜如何帮助选择文本。放大镜 API 与文本无关,您可以将此小部件用于各种用例,例如阅读小文本或放大地图上难以看到的地名。

An image showing how the magnifier appears after grabbing the right selection handle
图 1. 放大文本。当用户拖动右侧选择句柄时,放大镜会弹出以帮助精确放置。

放大镜已与平台小部件(如 TextViewEditTextWebView)集成。它在应用之间提供一致的文本操作。该小部件具有简单的 API,可用于根据您的应用上下文放大任何 View

API 用法

您可以按照如下方式以编程方式在任意视图上使用放大镜

Kotlin

val view: View = findViewById(R.id.view)
val magnifier = Magnifier.Builder(view).build()
magnifier.show(view.width / 2.0f, view.height / 2.0f)

Java

View view = findViewById(R.id.view);
Magnifier magnifier = new Magnifier.Builder(view).build();
magnifier.show(view.getWidth() / 2, view.getHeight() / 2);

假设视图层次结构具有第一个布局,则放大镜会显示在屏幕上,并包含视图内给定坐标为中心的区域。窗格显示在正在复制内容的中心点上方。放大镜会无限期地持续存在,直到用户将其关闭。

以下代码片段显示如何更改放大视图的背景

Kotlin

view.setBackgroundColor(...)

Java

view.setBackgroundColor(...);

假设背景颜色在放大镜内可见,则放大镜的内容已过期,因为仍然会显示具有旧背景颜色的视图区域。要刷新内容,请使用 update() 方法,如下所示

Kotlin

view.post { magnifier.update() }

Java

view.post(magnifier::update);

完成后,通过调用 dismiss() 方法关闭放大镜

Kotlin

magnifier.dismiss()

Java

magnifier.dismiss();

在用户交互时放大

放大镜的一个常见用例是让用户通过触摸来放大视图区域,如图 2 所示。

图 2. 放大镜跟随用户的触摸。它应用于包含左侧 `ImageView` 和右侧 TextViewViewGroup

您可以通过根据视图接收到的触摸事件更新放大镜来实现此目的,如下所示

Kotlin

imageView.setOnTouchListener { v, event ->
  when (event.actionMasked) {
    MotionEvent.ACTION_DOWN, MotionEvent.ACTION_MOVE -> {
      val viewPosition = IntArray(2)
      v.getLocationOnScreen(viewPosition)
      magnifier.show(event.rawX - viewPosition[0], event.rawY - viewPosition[1])
    }
    MotionEvent.ACTION_CANCEL, MotionEvent.ACTION_UP -> {
      magnifier.dismiss()
    }
  }
  true
}

Java

imageView.setOnTouchListener(new View.OnTouchListener() {
    @Override
    public boolean onTouch(View v, MotionEvent event) {
        switch (event.getActionMasked()) {
            case MotionEvent.ACTION_DOWN:
                // Fall through.
            case MotionEvent.ACTION_MOVE: {
                final int[] viewPosition = new int[2];
                v.getLocationOnScreen(viewPosition);
                magnifier.show(event.getRawX() - viewPosition[0],
                               event.getRawY() - viewPosition[1]);
                break;
            }
            case MotionEvent.ACTION_CANCEL:
                // Fall through.
            case MotionEvent.ACTION_UP: {
                magnifier.dismiss();
            }
        }
        return true;
    }
});

放大文本时的其他注意事项

对于平台文本小部件,了解特定的放大镜行为并在整个 Android 平台上为您的自定义文本视图一致地启用放大镜非常重要。请考虑以下几点

  • 当用户抓住插入句柄或选择句柄时,会立即触发放大镜。
  • 放大镜始终平滑地跟随用户的指尖水平移动,而垂直方向则固定在当前文本行的中心。
  • 水平移动时,放大镜仅在当前行的左右边界之间移动。此外,当用户的触摸离开这些边界并且触摸与最近边界之间的水平距离大于放大镜内容原始宽度的一半时,放大镜将被关闭,因为光标不再在放大镜内可见。
  • 当文本字体过大时,永远不会触发放大镜。当字体的下降和上升之间的差值大于适合放大镜的内容的高度时,文本被认为过大。在这种情况下触发放大镜不会增加价值。