增加注释文档

This commit is contained in:
许轲 2023-08-14 11:08:34 +08:00
parent fc490e8ddc
commit 1524094d6d
4 changed files with 102 additions and 3 deletions

View File

@ -7,37 +7,119 @@ import javafx.scene.control.TextArea;
import java.io.File; import java.io.File;
import java.util.List; import java.util.List;
/**
* 控制器接口类
*
*/
public interface ControllerInterface { public interface ControllerInterface {
/**
* 打开关联文件并创建 TextArea
*
* @param rawParameters 原始参数列表
* @return 创建的 TextArea
*/
TextArea openAssociatedFileAndCreateTextArea(List<String> rawParameters); TextArea openAssociatedFileAndCreateTextArea(List<String> rawParameters);
/**
* 获取换行符处理事件处理程序
*
* @param textArea 文本区域
* @return 换行符处理事件处理程序
*/
EventHandler<ActionEvent> getLineFeedEventHandler(TextArea textArea); EventHandler<ActionEvent> getLineFeedEventHandler(TextArea textArea);
/**
* 获取新建文件处理事件处理程序
*
* @param textArea 文本区域
* @return 新建文件处理事件处理程序
*/
EventHandler<ActionEvent> getNewFileEventHandler(TextArea textArea); EventHandler<ActionEvent> getNewFileEventHandler(TextArea textArea);
/**
* 获取打开文件处理事件处理程序
*
* @return 打开文件处理事件处理程序
*/
EventHandler<ActionEvent> getOpenFileEventHandler(); EventHandler<ActionEvent> getOpenFileEventHandler();
/**
* 获取保存文件处理事件处理程序
*
* @return 保存文件处理事件处理程序
*/
EventHandler<ActionEvent> getSaveFileEventHandler(); EventHandler<ActionEvent> getSaveFileEventHandler();
/**
* 获取另存为文件处理事件处理程序
*
* @return 另存为文件处理事件处理程序
*/
EventHandler<ActionEvent> getSaveAsFileEventHandler(); EventHandler<ActionEvent> getSaveAsFileEventHandler();
/**
* 自动保存
*
* @param textArea 文本区域
*/
void autoSave(TextArea textArea); void autoSave(TextArea textArea);
/**
* 更新状态标签
*
* @param textArea 文本区域
*/
void updateStatusLabel(TextArea textArea); void updateStatusLabel(TextArea textArea);
/**
* 打开关联文件
*
* @param filePath 文件路径
*/
void openAssociatedFile(String filePath); void openAssociatedFile(String filePath);
/**
* 获取文件内容
*
* @param file 文件
*/
void getText(File file); void getText(File file);
/**
* 更新编码标签
*
* @param text 编码标签文本
*/
void upDateEncodingLabel(String text); void upDateEncodingLabel(String text);
/**
* 获取光标所在行号
*
* @param caretPosition 光标位置
* @param text 文本内容
* @return 行号
*/
int getRow(int caretPosition, String text); int getRow(int caretPosition, String text);
/**
* 获取光标所在列号
*
* @param caretPosition 光标位置
* @param text 文本内容
* @return 列号
*/
int getColumn(int caretPosition, String text); int getColumn(int caretPosition, String text);
/**
* 初始化 TabPane
*/
void initTabPane(); void initTabPane();
/**
* 另存为文件
*/
void saveAsFile(); void saveAsFile();
} }

View File

@ -3,13 +3,25 @@ package org.jcnc.jnotepad.controller.event.handler;
import javafx.event.ActionEvent; import javafx.event.ActionEvent;
import javafx.event.EventHandler; import javafx.event.EventHandler;
import javafx.scene.control.TextArea; import javafx.scene.control.TextArea;
/**
* LineFeed 类是一个事件处理程序用于在文本区域中插入一个换行符
*/
public class LineFeed implements EventHandler<ActionEvent> { public class LineFeed implements EventHandler<ActionEvent> {
private final TextArea textArea; private final TextArea textArea;
/**
* 构造函数初始化 LineFeed 对象
* @param textArea 要操作的文本区域
*/
public LineFeed(TextArea textArea) { public LineFeed(TextArea textArea) {
this.textArea = textArea; this.textArea = textArea;
} }
/**
* 处理事件的方法将一个换行符插入到文本区域的末尾
* @param event 触发的事件对象
*/
@Override @Override
public void handle(ActionEvent event) { public void handle(ActionEvent event) {
String text = textArea.getText(); String text = textArea.getText();

View File

@ -9,6 +9,12 @@ import org.jcnc.jnotepad.view.manager.ViewManager;
import static org.jcnc.jnotepad.view.manager.ViewManager.tabPane; import static org.jcnc.jnotepad.view.manager.ViewManager.tabPane;
/**
*处理新建文件事件的事件处理程序
*当用户选择新建文件菜单或按钮时将创建一个新的文本编辑区并在Tab页中显示
* */
public class NewFile implements EventHandler<ActionEvent> { public class NewFile implements EventHandler<ActionEvent> {
@Override @Override
public void handle(ActionEvent event) { public void handle(ActionEvent event) {

View File

@ -6,9 +6,8 @@ import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
/** /**
* 编码检测工具类
编码检测工具类 *
*/ */
public class EncodingDetector { public class EncodingDetector {