2 * Jexer - Java Text User Interface
4 * The MIT License (MIT)
6 * Copyright (C) 2019 Kevin Lamonte
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24 * DEALINGS IN THE SOFTWARE.
26 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
31 import java
.util
.ResourceBundle
;
33 import jexer
.TApplication
;
34 import jexer
.TKeypress
;
37 import jexer
.bits
.CellAttributes
;
38 import jexer
.bits
.GraphicsChars
;
39 import jexer
.bits
.MnemonicString
;
40 import jexer
.bits
.StringUtils
;
41 import jexer
.event
.TKeypressEvent
;
42 import jexer
.event
.TMouseEvent
;
43 import static jexer
.TKeypress
.*;
46 * TMenu is a top-level collection of TMenuItems.
48 public class TMenu
extends TWindow
{
53 private static final ResourceBundle i18n
= ResourceBundle
.getBundle(TMenu
.class.getName());
55 // ------------------------------------------------------------------------
56 // Constants --------------------------------------------------------------
57 // ------------------------------------------------------------------------
59 // Reserved menu item IDs
60 public static final int MID_UNUSED
= -1;
63 public static final int MID_REPAINT
= 1;
64 public static final int MID_VIEW_IMAGE
= 2;
65 public static final int MID_SCREEN_OPTIONS
= 3;
68 public static final int MID_NEW
= 10;
69 public static final int MID_EXIT
= 11;
70 public static final int MID_QUIT
= MID_EXIT
;
71 public static final int MID_OPEN_FILE
= 12;
72 public static final int MID_SHELL
= 13;
75 public static final int MID_CUT
= 20;
76 public static final int MID_COPY
= 21;
77 public static final int MID_PASTE
= 22;
78 public static final int MID_CLEAR
= 23;
81 public static final int MID_FIND
= 30;
82 public static final int MID_REPLACE
= 31;
83 public static final int MID_SEARCH_AGAIN
= 32;
84 public static final int MID_GOTO_LINE
= 33;
87 public static final int MID_TILE
= 40;
88 public static final int MID_CASCADE
= 41;
89 public static final int MID_CLOSE_ALL
= 42;
90 public static final int MID_WINDOW_MOVE
= 43;
91 public static final int MID_WINDOW_ZOOM
= 44;
92 public static final int MID_WINDOW_NEXT
= 45;
93 public static final int MID_WINDOW_PREVIOUS
= 46;
94 public static final int MID_WINDOW_CLOSE
= 47;
97 public static final int MID_HELP_CONTENTS
= 50;
98 public static final int MID_HELP_INDEX
= 51;
99 public static final int MID_HELP_SEARCH
= 52;
100 public static final int MID_HELP_PREVIOUS
= 53;
101 public static final int MID_HELP_HELP
= 54;
102 public static final int MID_HELP_ACTIVE_FILE
= 55;
103 public static final int MID_ABOUT
= 56;
106 public static final int MID_TABLE_RENAME_ROW
= 60;
107 public static final int MID_TABLE_RENAME_COLUMN
= 61;
108 public static final int MID_TABLE_VIEW_ROW_LABELS
= 70;
109 public static final int MID_TABLE_VIEW_COLUMN_LABELS
= 71;
110 public static final int MID_TABLE_VIEW_HIGHLIGHT_ROW
= 72;
111 public static final int MID_TABLE_VIEW_HIGHLIGHT_COLUMN
= 73;
112 public static final int MID_TABLE_BORDER_NONE
= 80;
113 public static final int MID_TABLE_BORDER_ALL
= 81;
114 public static final int MID_TABLE_BORDER_CELL_NONE
= 82;
115 public static final int MID_TABLE_BORDER_CELL_ALL
= 83;
116 public static final int MID_TABLE_BORDER_RIGHT
= 84;
117 public static final int MID_TABLE_BORDER_LEFT
= 85;
118 public static final int MID_TABLE_BORDER_TOP
= 86;
119 public static final int MID_TABLE_BORDER_BOTTOM
= 87;
120 public static final int MID_TABLE_BORDER_DOUBLE_BOTTOM
= 88;
121 public static final int MID_TABLE_BORDER_THICK_BOTTOM
= 89;
122 public static final int MID_TABLE_DELETE_LEFT
= 100;
123 public static final int MID_TABLE_DELETE_UP
= 101;
124 public static final int MID_TABLE_DELETE_ROW
= 102;
125 public static final int MID_TABLE_DELETE_COLUMN
= 103;
126 public static final int MID_TABLE_INSERT_LEFT
= 104;
127 public static final int MID_TABLE_INSERT_RIGHT
= 105;
128 public static final int MID_TABLE_INSERT_ABOVE
= 106;
129 public static final int MID_TABLE_INSERT_BELOW
= 107;
130 public static final int MID_TABLE_COLUMN_NARROW
= 110;
131 public static final int MID_TABLE_COLUMN_WIDEN
= 111;
132 public static final int MID_TABLE_FILE_OPEN_CSV
= 115;
133 public static final int MID_TABLE_FILE_SAVE_CSV
= 116;
134 public static final int MID_TABLE_FILE_SAVE_TEXT
= 117;
137 public static final int MID_SPLIT_VERTICAL
= 200;
138 public static final int MID_SPLIT_HORIZONTAL
= 201;
140 // ------------------------------------------------------------------------
141 // Variables --------------------------------------------------------------
142 // ------------------------------------------------------------------------
145 * If true, this is a sub-menu. Note package private access.
147 boolean isSubMenu
= false;
150 * The X position of the menu's title.
155 * The shortcut and title.
157 private MnemonicString mnemonic
;
159 // ------------------------------------------------------------------------
160 // Constructors -----------------------------------------------------------
161 // ------------------------------------------------------------------------
164 * Public constructor.
166 * @param parent parent application
167 * @param x column relative to parent
168 * @param y row relative to parent
169 * @param label mnemonic menu title. Label must contain a keyboard
170 * shortcut (mnemonic), denoted by prefixing a letter with "&",
173 public TMenu(final TApplication parent
, final int x
, final int y
,
174 final String label
) {
176 super(parent
, label
, x
, y
, parent
.getScreen().getWidth(),
177 parent
.getScreen().getHeight());
179 // Setup the menu shortcut
180 mnemonic
= new MnemonicString(label
);
181 setTitle(mnemonic
.getRawLabel());
182 assert (mnemonic
.getShortcutIdx() >= 0);
184 // Recompute width and height to reflect an empty menu
185 setWidth(StringUtils
.width(getTitle()) + 4);
191 // ------------------------------------------------------------------------
192 // Event handlers ---------------------------------------------------------
193 // ------------------------------------------------------------------------
196 * Handle mouse button presses.
198 * @param mouse mouse button event
201 public void onMouseDown(final TMouseEvent mouse
) {
203 super.onMouseDown(mouse
);
206 for (TWidget widget
: getChildren()) {
207 if (widget
.mouseWouldHit(mouse
)) {
208 // Dispatch to this child, also activate it
211 // Set x and y relative to the child's coordinates
212 mouse
.setX(mouse
.getAbsoluteX() - widget
.getAbsoluteX());
213 mouse
.setY(mouse
.getAbsoluteY() - widget
.getAbsoluteY());
214 widget
.handleEvent(mouse
);
221 * Handle mouse button releases.
223 * @param mouse mouse button release event
226 public void onMouseUp(final TMouseEvent mouse
) {
230 for (TWidget widget
: getChildren()) {
231 if (widget
.mouseWouldHit(mouse
)) {
232 // Dispatch to this child, also activate it
235 // Set x and y relative to the child's coordinates
236 mouse
.setX(mouse
.getAbsoluteX() - widget
.getAbsoluteX());
237 mouse
.setY(mouse
.getAbsoluteY() - widget
.getAbsoluteY());
238 widget
.handleEvent(mouse
);
245 * Handle mouse movements.
247 * @param mouse mouse motion event
250 public void onMouseMotion(final TMouseEvent mouse
) {
253 // See if we should activate a different menu item
254 for (TWidget widget
: getChildren()) {
255 if ((mouse
.isMouse1())
256 && (widget
.mouseWouldHit(mouse
))
258 // Activate this menu item
260 if (widget
instanceof TSubMenu
) {
261 ((TSubMenu
) widget
).dispatch();
271 * @param keypress keystroke event
274 public void onKeypress(final TKeypressEvent keypress
) {
277 System.err.printf("keypress: %s active child: %s\n", keypress,
281 if (getActiveChild() != this) {
282 if (getActiveChild() instanceof TMenu
) {
283 getActiveChild().onKeypress(keypress
);
287 if (getActiveChild() instanceof TSubMenu
) {
288 TSubMenu subMenu
= (TSubMenu
) getActiveChild();
289 if (subMenu
.menu
.isActive()) {
290 subMenu
.onKeypress(keypress
);
296 if (keypress
.equals(kbEsc
)) {
297 getApplication().closeMenu();
300 if (keypress
.equals(kbDown
)) {
304 if (keypress
.equals(kbUp
)) {
308 if (keypress
.equals(kbRight
)) {
309 getApplication().switchMenu(true);
312 if (keypress
.equals(kbLeft
)) {
314 getApplication().closeSubMenu();
316 getApplication().switchMenu(false);
321 // Switch to a menuItem if it has an mnemonic
322 if (!keypress
.getKey().isFnKey()
323 && !keypress
.getKey().isAlt()
324 && !keypress
.getKey().isCtrl()) {
326 // System.err.println("Checking children for mnemonic...");
328 for (TWidget widget
: getChildren()) {
329 TMenuItem item
= (TMenuItem
) widget
;
330 if ((item
.isEnabled() == true)
331 && (item
.getMnemonic() != null)
332 && (Character
.toLowerCase(item
.getMnemonic().getShortcut())
333 == Character
.toLowerCase(keypress
.getKey().getChar()))
335 // System.err.println("activate: " + item);
337 // Send an enter keystroke to it
339 item
.handleEvent(new TKeypressEvent(kbEnter
));
345 // Dispatch the keypress to an active widget
346 for (TWidget widget
: getChildren()) {
347 if (widget
.isActive()) {
348 widget
.handleEvent(keypress
);
354 // ------------------------------------------------------------------------
355 // TWindow ----------------------------------------------------------------
356 // ------------------------------------------------------------------------
359 * Draw a top-level menu with title and menu items.
363 CellAttributes background
= getTheme().getColor("tmenu");
365 assert (isAbsoluteActive());
367 // Fill in the interior background
368 for (int i
= 0; i
< getHeight(); i
++) {
369 hLineXY(0, i
, getWidth(), ' ', background
);
379 cTopLeft
= GraphicsChars
.ULCORNER
;
380 cTopRight
= GraphicsChars
.URCORNER
;
381 cBottomLeft
= GraphicsChars
.LLCORNER
;
382 cBottomRight
= GraphicsChars
.LRCORNER
;
383 cHSide
= GraphicsChars
.SINGLE_BAR
;
385 // Place the corner characters
386 putCharXY(1, 0, cTopLeft
, background
);
387 putCharXY(getWidth() - 2, 0, cTopRight
, background
);
388 putCharXY(1, getHeight() - 1, cBottomLeft
, background
);
389 putCharXY(getWidth() - 2, getHeight() - 1, cBottomRight
, background
);
391 // Draw the box lines
392 hLineXY(1 + 1, 0, getWidth() - 4, cHSide
, background
);
393 hLineXY(1 + 1, getHeight() - 1, getWidth() - 4, cHSide
, background
);
396 drawBoxShadow(0, 0, getWidth(), getHeight());
399 // ------------------------------------------------------------------------
400 // TMenu ------------------------------------------------------------------
401 // ------------------------------------------------------------------------
404 * Set the menu title X position.
406 * @param titleX the position
408 public void setTitleX(final int titleX
) {
409 this.titleX
= titleX
;
413 * Get the menu title X position.
415 * @return the position
417 public int getTitleX() {
422 * Get the mnemonic string.
424 * @return the full mnemonic string
426 public MnemonicString
getMnemonic() {
431 * Convenience function to add a menu item.
433 * @param id menu item ID. Must be greater than 1024.
434 * @param label menu item label
435 * @return the new menu item
437 public TMenuItem
addItem(final int id
, final String label
) {
439 return addItemInternal(id
, label
, null);
443 * Convenience function to add a menu item.
445 * @param id menu item ID. Must be greater than 1024.
446 * @param label menu item label
447 * @param enabled default state for enabled
448 * @return the new menu item
450 public TMenuItem
addItem(final int id
, final String label
,
451 final boolean enabled
) {
454 return addItemInternal(id
, label
, null, enabled
);
458 * Convenience function to add a custom menu item.
460 * @param id menu item ID. Must be greater than 1024.
461 * @param label menu item label
462 * @param key global keyboard accelerator
463 * @return the new menu item
465 public TMenuItem
addItem(final int id
, final String label
,
466 final TKeypress key
) {
469 return addItemInternal(id
, label
, key
);
473 * Convenience function to add a custom menu item.
475 * @param id menu item ID. Must be greater than 1024.
476 * @param label menu item label
477 * @param key global keyboard accelerator
478 * @param enabled default state for enabled
479 * @return the new menu item
481 public TMenuItem
addItem(final int id
, final String label
,
482 final TKeypress key
, final boolean enabled
) {
484 TMenuItem item
= addItem(id
, label
, key
);
485 item
.setEnabled(enabled
);
490 * Convenience function to add a custom menu item.
492 * @param id menu item ID. Must be greater than 1024.
493 * @param label menu item label
494 * @param key global keyboard accelerator
495 * @return the new menu item
497 private TMenuItem
addItemInternal(final int id
, final String label
,
498 final TKeypress key
) {
500 return addItemInternal(id
, label
, key
, true);
504 * Convenience function to add a custom menu item.
506 * @param id menu item ID. Must be greater than 1024.
507 * @param label menu item label
508 * @param key global keyboard accelerator
509 * @param enabled default state for enabled
510 * @return the new menu item
512 private TMenuItem
addItemInternal(final int id
, final String label
,
513 final TKeypress key
, final boolean enabled
) {
515 int newY
= getChildren().size() + 1;
516 assert (newY
< getHeight());
518 TMenuItem menuItem
= new TMenuItem(this, id
, 1, newY
, label
);
519 menuItem
.setKey(key
);
520 menuItem
.setEnabled(enabled
);
521 setHeight(getHeight() + 1);
522 if (menuItem
.getWidth() + 2 > getWidth()) {
523 setWidth(menuItem
.getWidth() + 2);
525 for (TWidget widget
: getChildren()) {
526 widget
.setWidth(getWidth() - 2);
528 getApplication().addMenuItem(menuItem
);
529 getApplication().recomputeMenuX();
535 * Convenience function to add one of the default menu items.
537 * @param id menu item ID. Must be between 0 (inclusive) and 1023
539 * @return the new menu item
541 public TMenuItem
addDefaultItem(final int id
) {
542 return addDefaultItem(id
, true);
546 * Convenience function to add one of the default menu items.
548 * @param id menu item ID. Must be between 0 (inclusive) and 1023
550 * @param enabled default state for enabled
551 * @return the new menu item
553 public TMenuItem
addDefaultItem(final int id
, final boolean enabled
) {
558 TKeypress key
= null;
559 boolean checkable
= false;
560 boolean checked
= false;
565 label
= i18n
.getString("menuRepaintDesktop");
569 label
= i18n
.getString("menuViewImage");
572 case MID_SCREEN_OPTIONS
:
573 label
= i18n
.getString("menuScreenOptions");
577 label
= i18n
.getString("menuNew");
581 label
= i18n
.getString("menuExit");
586 label
= i18n
.getString("menuShell");
590 label
= i18n
.getString("menuOpen");
595 label
= i18n
.getString("menuCut");
599 label
= i18n
.getString("menuCopy");
603 label
= i18n
.getString("menuPaste");
607 label
= i18n
.getString("menuClear");
612 label
= i18n
.getString("menuFind");
615 label
= i18n
.getString("menuReplace");
617 case MID_SEARCH_AGAIN
:
618 label
= i18n
.getString("menuSearchAgain");
622 label
= i18n
.getString("menuGotoLine");
626 label
= i18n
.getString("menuWindowTile");
629 label
= i18n
.getString("menuWindowCascade");
632 label
= i18n
.getString("menuWindowCloseAll");
634 case MID_WINDOW_MOVE
:
635 label
= i18n
.getString("menuWindowMove");
638 case MID_WINDOW_ZOOM
:
639 label
= i18n
.getString("menuWindowZoom");
642 case MID_WINDOW_NEXT
:
643 label
= i18n
.getString("menuWindowNext");
646 case MID_WINDOW_PREVIOUS
:
647 label
= i18n
.getString("menuWindowPrevious");
650 case MID_WINDOW_CLOSE
:
651 label
= i18n
.getString("menuWindowClose");
655 case MID_HELP_CONTENTS
:
656 label
= i18n
.getString("menuHelpContents");
659 label
= i18n
.getString("menuHelpIndex");
662 case MID_HELP_SEARCH
:
663 label
= i18n
.getString("menuHelpSearch");
666 case MID_HELP_PREVIOUS
:
667 label
= i18n
.getString("menuHelpPrevious");
671 label
= i18n
.getString("menuHelpHelp");
673 case MID_HELP_ACTIVE_FILE
:
674 label
= i18n
.getString("menuHelpActive");
677 label
= i18n
.getString("menuHelpAbout");
680 case MID_TABLE_RENAME_COLUMN
:
681 label
= i18n
.getString("menuTableRenameColumn");
683 case MID_TABLE_RENAME_ROW
:
684 label
= i18n
.getString("menuTableRenameRow");
686 case MID_TABLE_VIEW_ROW_LABELS
:
687 label
= i18n
.getString("menuTableViewRowLabels");
691 case MID_TABLE_VIEW_COLUMN_LABELS
:
692 label
= i18n
.getString("menuTableViewColumnLabels");
696 case MID_TABLE_VIEW_HIGHLIGHT_ROW
:
697 label
= i18n
.getString("menuTableViewHighlightRow");
701 case MID_TABLE_VIEW_HIGHLIGHT_COLUMN
:
702 label
= i18n
.getString("menuTableViewHighlightColumn");
707 case MID_TABLE_BORDER_NONE
:
708 label
= i18n
.getString("menuTableBorderNone");
710 case MID_TABLE_BORDER_ALL
:
711 label
= i18n
.getString("menuTableBorderAll");
713 case MID_TABLE_BORDER_CELL_NONE
:
714 label
= i18n
.getString("menuTableBorderCellNone");
716 case MID_TABLE_BORDER_CELL_ALL
:
717 label
= i18n
.getString("menuTableBorderCellAll");
719 case MID_TABLE_BORDER_RIGHT
:
720 label
= i18n
.getString("menuTableBorderRight");
722 case MID_TABLE_BORDER_LEFT
:
723 label
= i18n
.getString("menuTableBorderLeft");
725 case MID_TABLE_BORDER_TOP
:
726 label
= i18n
.getString("menuTableBorderTop");
728 case MID_TABLE_BORDER_BOTTOM
:
729 label
= i18n
.getString("menuTableBorderBottom");
731 case MID_TABLE_BORDER_DOUBLE_BOTTOM
:
732 label
= i18n
.getString("menuTableBorderDoubleBottom");
734 case MID_TABLE_BORDER_THICK_BOTTOM
:
735 label
= i18n
.getString("menuTableBorderThickBottom");
737 case MID_TABLE_DELETE_LEFT
:
738 label
= i18n
.getString("menuTableDeleteLeft");
740 case MID_TABLE_DELETE_UP
:
741 label
= i18n
.getString("menuTableDeleteUp");
743 case MID_TABLE_DELETE_ROW
:
744 label
= i18n
.getString("menuTableDeleteRow");
746 case MID_TABLE_DELETE_COLUMN
:
747 label
= i18n
.getString("menuTableDeleteColumn");
749 case MID_TABLE_INSERT_LEFT
:
750 label
= i18n
.getString("menuTableInsertLeft");
752 case MID_TABLE_INSERT_RIGHT
:
753 label
= i18n
.getString("menuTableInsertRight");
755 case MID_TABLE_INSERT_ABOVE
:
756 label
= i18n
.getString("menuTableInsertAbove");
758 case MID_TABLE_INSERT_BELOW
:
759 label
= i18n
.getString("menuTableInsertBelow");
761 case MID_TABLE_COLUMN_NARROW
:
762 label
= i18n
.getString("menuTableColumnNarrow");
765 case MID_TABLE_COLUMN_WIDEN
:
766 label
= i18n
.getString("menuTableColumnWiden");
769 case MID_TABLE_FILE_OPEN_CSV
:
770 label
= i18n
.getString("menuTableFileOpenCsv");
772 case MID_TABLE_FILE_SAVE_CSV
:
773 label
= i18n
.getString("menuTableFileSaveCsv");
775 case MID_TABLE_FILE_SAVE_TEXT
:
776 label
= i18n
.getString("menuTableFileSaveText");
779 case MID_SPLIT_VERTICAL
:
780 label
= i18n
.getString("menuSplitVertical");
782 case MID_SPLIT_HORIZONTAL
:
783 label
= i18n
.getString("menuSplitHorizontal");
787 throw new IllegalArgumentException("Invalid menu ID: " + id
);
790 TMenuItem item
= addItemInternal(id
, label
, key
, enabled
);
791 item
.setCheckable(checkable
);
796 * Convenience function to add a menu separator.
798 public void addSeparator() {
799 int newY
= getChildren().size() + 1;
800 assert (newY
< getHeight());
802 // We just have to construct it, don't need to hang onto what it
804 new TMenuSeparator(this, 1, newY
);
805 setHeight(getHeight() + 1);
809 * Convenience function to add a sub-menu.
811 * @param title menu title. Title must contain a keyboard shortcut,
812 * denoted by prefixing a letter with "&", e.g. "&File"
813 * @return the new sub-menu
815 public TSubMenu
addSubMenu(final String title
) {
816 int newY
= getChildren().size() + 1;
817 assert (newY
< getHeight());
819 TSubMenu subMenu
= new TSubMenu(this, title
, 1, newY
);
820 setHeight(getHeight() + 1);
821 if (subMenu
.getWidth() + 2 > getWidth()) {
822 setWidth(subMenu
.getWidth() + 2);
824 for (TWidget widget
: getChildren()) {
825 widget
.setWidth(getWidth() - 2);
827 getApplication().recomputeMenuX();
829 subMenu
.menu
.setX(getX() + getWidth() - 2);