增加 AbstractVerticalBox.java 的注释

This commit is contained in:
许轲 2023-10-11 02:07:58 +08:00
parent e47ffd017c
commit dbc2c9270d
2 changed files with 39 additions and 11 deletions

View File

@ -7,7 +7,10 @@ import javafx.stage.Modality;
import javafx.stage.Stage; import javafx.stage.Stage;
/** /**
* 抽象窗格舞台 * 抽象窗格舞台
* <p>
* 该类是一个抽象的窗格舞台用于创建自定义的JavaFX窗口
* </p>
* *
* @author gewuyou * @author gewuyou
*/ */
@ -15,40 +18,46 @@ public abstract class AbstractPaneStage extends BorderPane {
private final Stage stage = new Stage(); private final Stage stage = new Stage();
/** /**
* 获取舞台图标 * 获取舞台图标
* *
* @return 舞台图标 * @return 舞台图标
*/ */
protected abstract Image getStageIcon(); protected abstract Image getStageIcon();
/** /**
* 获取舞台标题 * 获取舞台标题
* *
* @return 舞台标题 * @return 舞台标题
*/ */
protected abstract String getStageTitle(); protected abstract String getStageTitle();
/** /**
* 获取自定义舞台 * 获取自定义舞台场景
* *
* @return 舞台 * @return 舞台场景
*/ */
protected abstract Scene getCustomizationScene(); protected abstract Scene getCustomizationScene();
/** /**
* 初始化方法 * 初始化方法
* <p>
* 在此方法中您可以进行与窗口相关的初始化操作
* </p>
*/ */
protected abstract void initialize(); protected abstract void initialize();
/** /**
* 自定义启动方法 * 自定义启动方法
* *
* @param stage 自定义舞台 * @param stage 自定义舞台
*/ */
public abstract void run(Stage stage); public abstract void run(Stage stage);
/** /**
* 启动方法 * 启动方法
* <p>
* 该方法设置窗口的图标标题场景并将窗口设置为模态对话框然后显示窗口
* </p>
*/ */
public void run() { public void run() {
stage.getIcons().add(getStageIcon()); stage.getIcons().add(getStageIcon());

View File

@ -5,30 +5,49 @@ import javafx.scene.layout.VBox;
import org.jcnc.jnotepad.component.module.interfaces.VerticalBoxAble; import org.jcnc.jnotepad.component.module.interfaces.VerticalBoxAble;
/** /**
* 抽象垂直盒子类 * 抽象垂直盒子类
* *
* <p>这个抽象类继承自JavaFX的VBox类实现了VBoxAble接口用于管理垂直排列的UI组件</p> * <p>这个抽象类继承自 JavaFX VBox 实现了 VerticalBoxAble 接口用于管理垂直排列的 UI 组件</p>
*
* <p>请注意这个类只是一个抽象类用于提供基本的垂直盒子布局功能您可以继承此类并添加自己的 UI 组件以构建更复杂的界面</p>
* *
* @author luke * @author luke
*/ */
public abstract class AbstractVerticalBox extends VBox implements VerticalBoxAble { public abstract class AbstractVerticalBox extends VBox implements VerticalBoxAble {
private final VBox vBox; private final VBox vBox;
/**
* 创建一个新的 AbstractVerticalBox 实例
*/
public AbstractVerticalBox() { public AbstractVerticalBox() {
vBox = new VBox(); vBox = new VBox();
} }
/**
* 向垂直盒子添加一个节点
*
* @param node 要添加的节点
*/
@Override @Override
public void addChild(Node node) { public void addChild(Node node) {
vBox.getChildren().add(node); vBox.getChildren().add(node);
} }
/**
* 向垂直盒子添加多个节点
*
* @param nodes 要添加的节点数组
*/
@Override @Override
public void addChild(Node... nodes) { public void addChild(Node... nodes) {
vBox.getChildren().addAll(nodes); vBox.getChildren().addAll(nodes);
} }
/**
* 获取垂直盒子的实例
*
* @return 垂直盒子实例
*/
@Override @Override
public VBox getVerticalBox() { public VBox getVerticalBox() {
return vBox; return vBox;