UndoFX 使用指南

UndoFX 使用指南

UndoFX 项目地址: https://gitcode.com/gh_mirrors/und/UndoFX

项目介绍

UndoFX 是一款专为 JavaFX 平台设计的强大撤销/重做管理器，由Tomas Mikula开发。此项目简化了在JavaFX应用中实现撤销和重做的复杂度，使得开发者能够便捷地赋予用户撤销与重做更改的能力。相较于Swing中的可变UndoableEdit设计，UndoFX特别支持不可变对象的处理，并提供了高级特性，如合并连续变更和标记特定状态，增强了用户体验。

项目快速启动

Maven集成

如果你的项目是基于Maven的，只需在pom.xml文件中添加以下依赖：

<dependency>
    <groupId>org.fxmisc.undo</groupId>
    <artifactId>undofx</artifactId>
    <version>2.1.1</version>
</dependency>

Gradle集成

对于Gradle用户，可以在build.gradle文件中这样配置：

dependencies {
    implementation 'org.fxmisc.undo:undofx:2.1.1'
}

手动配置步骤，包括下载JAR文件并添加至类路径，适用于不使用构建系统的情况。

应用案例和最佳实践

在实际应用中，比如文本编辑器或图像处理软件，通过创建自定义的Change对象来封装用户的每一次可逆操作。下面是一个简单的示例，展示如何使用UndoManager：

import org.fxmisc.undo.UndoManager;
import org.fxmisc.undo.UndoPosition;

// 初始化UndoManager
UndoManager undoManager = new UndoManager();

// 实现一个示例变更对象，这里省略具体的MyChangeObject实现细节
MyChangeObject change = new MyChangeObject();

// 将变更添加到撤销队列中
undoManager.add(change);

// 操作撤销逻辑检查与执行
if (undoManager.isUndoAvailable()) {
    undoManager.undo();
}

// 重做逻辑检查与执行
if (undoManager.isRedoAvailable()) {
    undoManager.redo();
}

最佳实践建议每个操作对应一个明确的Change对象，并适当使用preventMerge()和mark()方法来维护清晰的历史记录。

典型生态项目

UndoFX虽独立，但常与JavaFX生态系统中的其他库，如JFXtras和ControlsFX联合使用，以增强界面效果和提供更复杂的交互体验。这样的整合使得开发者能够在保留一致的UI/UX设计的同时，增加诸如高级控件或富文本编辑器中的撤销/重做功能，显著提升了应用程序的专业度和用户满意度。

集成这些生态项目不仅能扩展功能，而且通过UndoFX的高效管理，确保了撤销/重做机制的平滑运作，进一步优化了最终产品的质量。

UndoFX 项目地址: https://gitcode.com/gh_mirrors/und/UndoFX