add some documentation

This commit is contained in:
hneemann 2016-04-24 08:12:42 +02:00
parent c823418efb
commit be4133e386

View File

@ -172,6 +172,14 @@ public class Main extends JFrame implements ClosingWindowListener.ConfirmSave, E
setLocationRelativeTo(parent); setLocationRelativeTo(parent);
} }
/**
* Creates the file menu and adds it to menu and toolbar
*
* @param menuBar the menuBar
* @param toolBar the toolBar
* @param normalMode if false, menu is added in nested mode
* @return the save action
*/
private ToolTipAction createFileMenu(JMenuBar menuBar, JToolBar toolBar, boolean normalMode) { private ToolTipAction createFileMenu(JMenuBar menuBar, JToolBar toolBar, boolean normalMode) {
ToolTipAction newFile = new ToolTipAction(Lang.get("menu_new"), ICON_NEW) { ToolTipAction newFile = new ToolTipAction(Lang.get("menu_new"), ICON_NEW) {
@Override @Override
@ -252,6 +260,12 @@ public class Main extends JFrame implements ClosingWindowListener.ConfirmSave, E
return save; return save;
} }
/**
* Creates the edit menu
*
* @param menuBar the menu bar
* @param elementStateAction state action to add to menu
*/
private void createEditMenu(JMenuBar menuBar, ToolTipAction elementStateAction) { private void createEditMenu(JMenuBar menuBar, ToolTipAction elementStateAction) {
JMenu edit = new JMenu(Lang.get("menu_edit")); JMenu edit = new JMenu(Lang.get("menu_edit"));
menuBar.add(edit); menuBar.add(edit);
@ -294,6 +308,12 @@ public class Main extends JFrame implements ClosingWindowListener.ConfirmSave, E
edit.add(editAttributes.createJMenuItem()); edit.add(editAttributes.createJMenuItem());
} }
/**
* Creates the start menu
*
* @param menuBar the menu bar
* @param toolBar the tool bar
*/
private void createStartMenu(JMenuBar menuBar, JToolBar toolBar) { private void createStartMenu(JMenuBar menuBar, JToolBar toolBar) {
doStep = new ToolTipAction(Lang.get("menu_step"), ICON_STEP) { doStep = new ToolTipAction(Lang.get("menu_step"), ICON_STEP) {
@Override @Override
@ -370,7 +390,12 @@ public class Main extends JFrame implements ClosingWindowListener.ConfirmSave, E
toolBar.add(doStep.createJButtonNoText()); toolBar.add(doStep.createJButtonNoText());
} }
private JMenu createAnalyseMenu(JMenuBar menuBar) { /**
* Creates the analyse menu
*
* @param menuBar the menu bar
*/
private void createAnalyseMenu(JMenuBar menuBar) {
JMenu analyse = new JMenu(Lang.get("menu_analyse")); JMenu analyse = new JMenu(Lang.get("menu_analyse"));
menuBar.add(analyse); menuBar.add(analyse);
analyse.add(new ToolTipAction(Lang.get("menu_analyse")) { analyse.add(new ToolTipAction(Lang.get("menu_analyse")) {
@ -387,8 +412,6 @@ public class Main extends JFrame implements ClosingWindowListener.ConfirmSave, E
} }
.setToolTip(Lang.get("menu_analyse_tt")) .setToolTip(Lang.get("menu_analyse_tt"))
.createJMenuItem()); .createJMenuItem());
return analyse;
} }
private void orderMeasurements() { private void orderMeasurements() {