Flutter DragTarget拖拽控件详解

在这里插入图片描述

文章目录

- - 1. `DragTarget` 控件的构造函数
  - - 主要参数：
  - 2. `DragTarget` 的工作原理
  - 3. 常见用法
  - - 示例 1：实现一个简单的拖拽目标
    - 解释：
    - 示例 2：与 `Draggable` 结合使用
    - 解释：
  - 4. `DragTarget` 的回调详解
  - 5. 总结

DragTarget 是 Flutter 中用于处理拖拽操作的控件，它定义了一个区域，允许你将其他控件（通常是通过 Draggable 控件实现的可拖拽物体）拖拽到该区域，并在拖拽结束时根据情况更新该区域的内容或执行其他操作。

1. `DragTarget` 控件的构造函数

DragTarget<T>({
  Key? key,
  required WillAccept<T> onWillAccept,  // 拖拽对象是否可以接受
  required void Function(DragTargetDetails<T> details) onAccept,  // 拖拽对象被接受时执行的回调
  void Function(DragTargetDetails<T> details)? onEnter,  // 拖拽对象进入目标区域时执行的回调
  void Function(DragTargetDetails<T> details)? onLeave,  // 拖拽对象离开目标区域时执行的回调
  void Function(DragTargetDetails<T> details)? onCancel,  // 拖拽对象取消时执行的回调
  double? elevation,  // 控件的阴影高度
  Color? color,  // 控件的背景色
  TextStyle? textStyle,  // 控件的文本样式
  bool? feedback,  // 控件是否启用反馈效果
})

主要参数：

onWillAccept：一个函数，决定拖拽的对象是否可以接受。返回 true 或 false。
onAccept：当拖拽对象被接受时触发的回调函数。接收一个 DragTargetDetails 参数，包含了拖拽的数据。
onEnter：当拖拽对象进入 DragTarget 区域时调用。接收 DragTargetDetails，可以用来更新界面，如改变颜色。
onLeave：当拖拽对象离开 DragTarget 区域时调用。
onCancel：当拖拽对象被取消时触发，用来做一些撤销操作。
elevation：用于设置 DragTarget 区域的阴影效果，通常影响视觉层次感。
color：设置 DragTarget 的背景颜色。
textStyle：设置文本样式。
feedback：控制是否显示拖拽反馈。

2. `DragTarget` 的工作原理

DragTarget 负责接收从其他控件（如 Draggable）拖拽过来的数据，并决定是否处理这些数据。它通过回调函数来响应拖拽事件。
拖拽的过程包括：
1. 拖拽对象进入 DragTarget 区域。
2. 拖拽对象悬停在目标区域内。
3. 拖拽对象离开目标区域。
4. 拖拽对象被放置到目标区域内。
onWillAccept 用来判断拖拽对象是否可以被接受，onEnter 和 onLeave 用来响应拖拽对象进入或离开区域的动作，onAccept 则在拖拽成功放置后触发。

3. 常见用法

示例 1：实现一个简单的拖拽目标

import 'package:flutter/material.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('DragTarget Example')),
        body: Center(
          child: DragTarget<int>(
            onWillAccept: (data) => data != null,  // 允许接收非空的数据
            onAccept: (data) {
              ScaffoldMessenger.of(context).showSnackBar(
                SnackBar(content: Text('Received data: $data')),
              );
            },
            builder: (context, candidateData, rejectedData) {
              return Container(
                width: 200,
                height: 200,
                color: Colors.blue,
                child: Center(child: Text('Drag here')),
              );
            },
          ),
        ),
      ),
    );
  }
}

解释：

在这个简单的例子中，DragTarget<int> 用来接收类型为 int 的数据。
onWillAccept 判断是否接受数据，如果数据不为 null 则返回 true。
onAccept 被调用时显示一个 SnackBar，显示接收到的数据。
builder 构建 DragTarget 区域的 UI，在这个例子中是一个蓝色的方形区域。

示例 2：与 `Draggable` 结合使用

import 'package:flutter/material.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('DragTarget with Draggable')),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Draggable<int>(
                data: 42,  // 传递的数据
                child: CircleAvatar(
                  radius: 50.0,
                  child: Text('Drag Me'),
                ),
                feedback: Material(
                  color: Colors.transparent,
                  child: CircleAvatar(
                    radius: 50.0,
                    backgroundColor: Colors.blue,
                    child: Text('Dragging'),
                  ),
                ),
                childWhenDragging: CircleAvatar(
                  radius: 50.0,
                  backgroundColor: Colors.grey,
                  child: Text('Gone'),
                ),
              ),
              SizedBox(height: 50),
              DragTarget<int>(
                onWillAccept: (data) => data != null,  // 允许接收数据
                onAccept: (data) {
                  ScaffoldMessenger.of(context).showSnackBar(
                    SnackBar(content: Text('Dropped: $data')),
                  );
                },
                builder: (context, candidateData, rejectedData) {
                  return Container(
                    width: 200,
                    height: 200,
                    color: Colors.orange,
                    child: Center(child: Text('Drop Here')),
                  );
                },
              ),
            ],
          ),
        ),
      ),
    );
  }
}

解释：

在此示例中，Draggable 控件创建了一个可拖拽的圆形，用户可以将它拖拽到下方的 DragTarget 区域。
Draggable 的 data 参数传递了一个整数（42）。当拖拽对象被放置到 DragTarget 区域时，onAccept 回调被触发，显示一个 SnackBar，告知接收到的数据。

4. `DragTarget` 的回调详解

onWillAccept：此回调决定是否接受拖拽的对象。它接收拖拽的数据作为参数，返回一个布尔值，表示是否接受该数据。如果返回 true，表示可以放置数据；否则，数据将被拒绝。
onEnter：此回调在拖拽对象进入 DragTarget 区域时触发，可以用来改变目标区域的样式（例如改变颜色），提示用户目标区域准备好接受拖拽对象。
onLeave：此回调在拖拽对象离开 DragTarget 区域时触发，可以用来恢复区域的样式。
onAccept：此回调在拖拽对象成功放置在目标区域时触发，可以用于处理拖拽成功后需要执行的逻辑（例如更新界面、保存数据等）。
onCancel：当拖拽操作被取消时（例如拖拽对象超出了目标区域并没有被放置），会调用该回调。