增加 AbstractPaneStage.java 的注释

This commit is contained in:
许轲 2023-10-11 02:08:05 +08:00
parent dbc2c9270d
commit eb7a599e03

View File

@ -15,7 +15,11 @@ import org.slf4j.Logger;
import java.util.Map; import java.util.Map;
/** /**
* 抽象顶部菜单 * 抽象顶部菜单类
*
* <p>
* 此抽象类用于创建顶部菜单包括菜单项的注册和初始化
* </p>
* *
* @author gewuyou * @author gewuyou
*/ */
@ -56,7 +60,7 @@ public abstract class AbstractTopMenu {
* @param menuItem 菜单项 * @param menuItem 菜单项
* @param menuItemName 菜单项名称 * @param menuItemName 菜单项名称
* @param userData 用户数据用来存放必要的数据比如按钮菜单项名称 * @param userData 用户数据用来存放必要的数据比如按钮菜单项名称
* @param eventHandler 事件 * @param eventHandler 事件处理器
*/ */
public void registerMenuItem(MenuItem menuItem, String menuItemName, Object userData, EventHandler<ActionEvent> eventHandler) { public void registerMenuItem(MenuItem menuItem, String menuItemName, Object userData, EventHandler<ActionEvent> eventHandler) {
getMenuItems().put(menuItemName, menuItem); getMenuItems().put(menuItemName, menuItem);
@ -70,9 +74,8 @@ public abstract class AbstractTopMenu {
* @param checkMenuItem 检查菜单项 * @param checkMenuItem 检查菜单项
* @param menuItemName 菜单项名称 * @param menuItemName 菜单项名称
* @param userData 用户数据用来存放必要的数据比如按钮菜单项名称 * @param userData 用户数据用来存放必要的数据比如按钮菜单项名称
* @param listener 监听事件 * @param listener 监听
*/ */
public void registerMenuItem(CheckMenuItem checkMenuItem, String menuItemName, Object userData, ChangeListener<Boolean> listener) { public void registerMenuItem(CheckMenuItem checkMenuItem, String menuItemName, Object userData, ChangeListener<Boolean> listener) {
getMenuItems().put(menuItemName, checkMenuItem); getMenuItems().put(menuItemName, checkMenuItem);
checkMenuItem.setUserData(userData); checkMenuItem.setUserData(userData);
@ -85,9 +88,8 @@ public abstract class AbstractTopMenu {
* @param radioMenuItem 单选菜单项 * @param radioMenuItem 单选菜单项
* @param menuItemName 菜单项名称 * @param menuItemName 菜单项名称
* @param userData 用户数据用来存放必要的数据 * @param userData 用户数据用来存放必要的数据
* @param eventHandler 操作事件 * @param eventHandler 事件处理器
*/ */
public void registerRadioMenuItem(Map<String, RadioMenuItem> radioMenuItems, RadioMenuItem radioMenuItem, String menuItemName, Object userData, EventHandler<ActionEvent> eventHandler) { public void registerRadioMenuItem(Map<String, RadioMenuItem> radioMenuItems, RadioMenuItem radioMenuItem, String menuItemName, Object userData, EventHandler<ActionEvent> eventHandler) {
radioMenuItems.put(menuItemName, radioMenuItem); radioMenuItems.put(menuItemName, radioMenuItem);
radioMenuItem.setUserData(userData); radioMenuItem.setUserData(userData);
@ -101,7 +103,7 @@ public abstract class AbstractTopMenu {
registerTopMenu(); registerTopMenu();
logger.info("初始化菜单!"); logger.info("初始化菜单!");
Menu menu = getMenu(); Menu menu = getMenu();
// 文件菜单 // 菜单名称国际化
UiResourceBundle.bindStringProperty(menu.textProperty(), getMenuName()); UiResourceBundle.bindStringProperty(menu.textProperty(), getMenuName());
// 初始化菜单项 // 初始化菜单项
initMenuItems(getMenuItems(), menu); initMenuItems(getMenuItems(), menu);
@ -113,7 +115,6 @@ public abstract class AbstractTopMenu {
* @param menuItems 菜单项集合 * @param menuItems 菜单项集合
* @param menu 菜单 * @param menu 菜单
*/ */
private void initMenuItems(Map<String, MenuItem> menuItems, Menu menu) { private void initMenuItems(Map<String, MenuItem> menuItems, Menu menu) {
logger.info("初始化菜单项!"); logger.info("初始化菜单项!");
var itemMap = topMenuBar.getAllItemMap(); var itemMap = topMenuBar.getAllItemMap();