2 * Jexer - Java Text User Interface
4 * License: LGPLv3 or later
6 * This module is licensed under the GNU Lesser General Public License
7 * Version 3. Please see the file "COPYING" in this directory for more
8 * information about the GNU Lesser General Public License Version 3.
10 * Copyright (C) 2015 Kevin Lamonte
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU Lesser General Public License
14 * as published by the Free Software Foundation; either version 3 of
15 * the License, or (at your option) any later version.
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with this program; if not, see
24 * http://www.gnu.org/licenses/, or write to the Free Software
25 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
28 * @author Kevin Lamonte [kevin.lamonte@gmail.com]
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
.event
.TKeypressEvent
;
41 import jexer
.event
.TMouseEvent
;
42 import static jexer
.TKeypress
.*;
45 * TMenu is a top-level collection of TMenuItems.
47 public final class TMenu
extends TWindow
{
50 * If true, this is a sub-menu. Note package private access.
52 boolean isSubMenu
= false;
55 * The shortcut and title.
57 private MnemonicString mnemonic
;
60 * Get the mnemonic string.
62 * @return the full mnemonic string
64 public MnemonicString
getMnemonic() {
68 // Reserved menu item IDs
69 public static final int MID_UNUSED
= -1;
72 public static final int MID_EXIT
= 1;
73 public static final int MID_QUIT
= MID_EXIT
;
74 public static final int MID_OPEN_FILE
= 2;
75 public static final int MID_SHELL
= 3;
78 public static final int MID_CUT
= 10;
79 public static final int MID_COPY
= 11;
80 public static final int MID_PASTE
= 12;
81 public static final int MID_CLEAR
= 13;
84 public static final int MID_TILE
= 20;
85 public static final int MID_CASCADE
= 21;
86 public static final int MID_CLOSE_ALL
= 22;
87 public static final int MID_WINDOW_MOVE
= 23;
88 public static final int MID_WINDOW_ZOOM
= 24;
89 public static final int MID_WINDOW_NEXT
= 25;
90 public static final int MID_WINDOW_PREVIOUS
= 26;
91 public static final int MID_WINDOW_CLOSE
= 27;
96 * @param parent parent application
97 * @param x column relative to parent
98 * @param y row relative to parent
99 * @param label mnemonic menu title. Label must contain a keyboard
100 * shortcut (mnemonic), denoted by prefixing a letter with "&",
103 public TMenu(final TApplication parent
, final int x
, final int y
,
104 final String label
) {
106 super(parent
, label
, x
, y
, parent
.getScreen().getWidth(),
107 parent
.getScreen().getHeight());
109 // My parent constructor added me as a window, get rid of that
110 parent
.closeWindow(this);
112 // Setup the menu shortcut
113 mnemonic
= new MnemonicString(label
);
114 setTitle(mnemonic
.getRawLabel());
115 assert (mnemonic
.getShortcutIdx() >= 0);
117 // Recompute width and height to reflect an empty menu
118 setWidth(getTitle().length() + 4);
125 * Draw a top-level menu with title and menu items.
129 CellAttributes menuColor
;
130 CellAttributes background
= getTheme().getColor("tmenu");
132 if (getAbsoluteActive()) {
133 menuColor
= getTheme().getColor("tmenu.highlighted");
135 menuColor
= getTheme().getColor("tmenu");
138 assert (getAbsoluteActive());
140 // Fill in the interior background
141 for (int i
= 0; i
< getHeight(); i
++) {
142 hLineXY(0, i
, getWidth(), ' ', background
);
152 cTopLeft
= GraphicsChars
.ULCORNER
;
153 cTopRight
= GraphicsChars
.URCORNER
;
154 cBottomLeft
= GraphicsChars
.LLCORNER
;
155 cBottomRight
= GraphicsChars
.LRCORNER
;
156 cHSide
= GraphicsChars
.SINGLE_BAR
;
158 // Place the corner characters
159 putCharXY(1, 0, cTopLeft
, background
);
160 putCharXY(getWidth() - 2, 0, cTopRight
, background
);
161 putCharXY(1, getHeight() - 1, cBottomLeft
, background
);
162 putCharXY(getWidth() - 2, getHeight() - 1, cBottomRight
, background
);
164 // Draw the box lines
165 hLineXY(1 + 1, 0, getWidth() - 4, cHSide
, background
);
166 hLineXY(1 + 1, getHeight() - 1, getWidth() - 4, cHSide
, background
);
169 getScreen().drawBoxShadow(0, 0, getWidth(), getHeight());
173 * Handle mouse button presses.
175 * @param mouse mouse button event
178 public void onMouseDown(final TMouseEvent mouse
) {
182 for (TWidget widget
: getChildren()) {
183 if (widget
.mouseWouldHit(mouse
)) {
184 // Dispatch to this child, also activate it
187 // Set x and y relative to the child's coordinates
188 mouse
.setX(mouse
.getAbsoluteX() - widget
.getAbsoluteX());
189 mouse
.setY(mouse
.getAbsoluteY() - widget
.getAbsoluteY());
190 widget
.handleEvent(mouse
);
197 * Handle mouse button releases.
199 * @param mouse mouse button release event
202 public void onMouseUp(final TMouseEvent 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 movements.
223 * @param mouse mouse motion event
226 public void onMouseMotion(final TMouseEvent mouse
) {
229 // See if we should activate a different menu item
230 for (TWidget widget
: getChildren()) {
231 if ((mouse
.getMouse1())
232 && (widget
.mouseWouldHit(mouse
))
234 // Activate this menu item
236 if (widget
instanceof TSubMenu
) {
237 ((TSubMenu
) widget
).dispatch();
247 * @param keypress keystroke event
250 public void onKeypress(final TKeypressEvent keypress
) {
251 if (getActiveChild() != null) {
252 if (getActiveChild() instanceof TSubMenu
) {
253 getActiveChild().onKeypress(keypress
);
258 if (keypress
.equals(kbEsc
)) {
259 getApplication().closeMenu();
262 if (keypress
.equals(kbDown
)) {
266 if (keypress
.equals(kbUp
)) {
270 if (keypress
.equals(kbRight
)) {
272 getApplication().switchMenu(true);
276 if (keypress
.equals(kbLeft
)) {
278 getApplication().closeSubMenu();
280 getApplication().switchMenu(false);
285 // Switch to a menuItem if it has an mnemonic
286 if (!keypress
.getKey().getIsKey()
287 && !keypress
.getKey().getAlt()
288 && !keypress
.getKey().getCtrl()) {
289 for (TWidget widget
: getChildren()) {
290 TMenuItem item
= (TMenuItem
) widget
;
291 if ((item
.getMnemonic() != null)
292 && (Character
.toLowerCase(item
.getMnemonic().getShortcut())
293 == Character
.toLowerCase(keypress
.getKey().getCh()))
295 // Send an enter keystroke to it
297 item
.handleEvent(new TKeypressEvent(kbEnter
));
303 // Dispatch the keypress to an active widget
304 for (TWidget widget
: getChildren()) {
305 if (widget
.getActive()) {
306 widget
.handleEvent(keypress
);
313 * Convenience function to add a custom menu item.
315 * @param id menu item ID. Must be greater than 1024.
316 * @param label menu item label
317 * @param key global keyboard accelerator
318 * @return the new menu item
320 public final TMenuItem
addItem(final int id
, final String label
,
321 final TKeypress key
) {
324 return addItemInternal(id
, label
, key
);
328 * Convenience function to add a custom menu item.
330 * @param id menu item ID. Must be greater than 1024.
331 * @param label menu item label
332 * @param key global keyboard accelerator
333 * @return the new menu item
335 private TMenuItem
addItemInternal(final int id
, final String label
,
336 final TKeypress key
) {
338 int newY
= getChildren().size() + 1;
339 assert (newY
< getHeight());
341 TMenuItem menuItem
= new TMenuItem(this, id
, 1, newY
, label
);
342 menuItem
.setKey(key
);
343 setHeight(getHeight() + 1);
344 if (menuItem
.getWidth() + 2 > getWidth()) {
345 setWidth(menuItem
.getWidth() + 2);
347 for (TWidget widget
: getChildren()) {
348 widget
.setWidth(getWidth() - 2);
350 getApplication().addAccelerator(menuItem
, key
.toLowerCase());
351 getApplication().recomputeMenuX();
357 * Convenience function to add a menu item.
359 * @param id menu item ID. Must be greater than 1024.
360 * @param label menu item label
361 * @return the new menu item
363 public final TMenuItem
addItem(final int id
, final String label
) {
365 return addItemInternal(id
, label
);
369 * Convenience function to add a menu item.
371 * @param id menu item ID
372 * @param label menu item label
373 * @return the new menu item
375 private TMenuItem
addItemInternal(final int id
, final String label
) {
376 int newY
= getChildren().size() + 1;
377 assert (newY
< getHeight());
379 TMenuItem menuItem
= new TMenuItem(this, id
, 1, newY
, label
);
380 setHeight(getHeight() + 1);
381 if (menuItem
.getWidth() + 2 > getWidth()) {
382 setWidth(menuItem
.getWidth() + 2);
384 for (TWidget widget
: getChildren()) {
385 widget
.setWidth(getWidth() - 2);
387 getApplication().recomputeMenuX();
393 * Convenience function to add one of the default menu items.
395 * @param id menu item ID. Must be between 0 (inclusive) and 1023
397 * @return the new menu item
399 public final TMenuItem
addDefaultItem(final int id
) {
404 TKeypress key
= null;
405 boolean hasKey
= true;
451 label
= "Cl&ose All";
454 case MID_WINDOW_MOVE
:
455 label
= "&Size/Move";
458 case MID_WINDOW_ZOOM
:
462 case MID_WINDOW_NEXT
:
466 case MID_WINDOW_PREVIOUS
:
470 case MID_WINDOW_CLOSE
:
477 throw new IllegalArgumentException("Invalid menu ID: " + id
);
481 return addItemInternal(id
, label
, key
);
483 return addItemInternal(id
, label
);
487 * Convenience function to add a menu separator.
489 public final void addSeparator() {
490 int newY
= getChildren().size() + 1;
491 assert (newY
< getHeight());
493 TMenuItem menuItem
= new TMenuSeparator(this, 1, newY
);
494 setHeight(getHeight() + 1);
498 * Convenience function to add a sub-menu.
500 * @param title menu title. Title must contain a keyboard shortcut,
501 * denoted by prefixing a letter with "&", e.g. "&File"
502 * @return the new sub-menu
504 public final TSubMenu
addSubMenu(final String title
) {
505 int newY
= getChildren().size() + 1;
506 assert (newY
< getHeight());
508 TSubMenu subMenu
= new TSubMenu(this, title
, 1, newY
);
509 setHeight(getHeight() + 1);
510 if (subMenu
.getWidth() + 2 > getWidth()) {
511 setWidth(subMenu
.getWidth() + 2);
513 for (TWidget widget
: getChildren()) {
514 widget
.setWidth(getWidth() - 2);
516 getApplication().recomputeMenuX();
518 subMenu
.menu
.setX(getX() + getWidth() - 2);