/*
* Jexer - Java Text User Interface
*
- * License: LGPLv3 or later
+ * The MIT License (MIT)
*
- * This module is licensed under the GNU Lesser General Public License
- * Version 3. Please see the file "COPYING" in this directory for more
- * information about the GNU Lesser General Public License Version 3.
+ * Copyright (C) 2019 Kevin Lamonte
*
- * Copyright (C) 2015 Kevin Lamonte
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
*
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 3 of
- * the License, or (at your option) any later version.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
*
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, see
- * http://www.gnu.org/licenses/, or write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- * 02110-1301 USA
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
*
* @author Kevin Lamonte [kevin.lamonte@gmail.com]
* @version 1
import jexer.bits.CellAttributes;
import jexer.bits.GraphicsChars;
import jexer.bits.MnemonicString;
+import jexer.bits.StringUtils;
import jexer.event.TKeypressEvent;
import jexer.event.TMouseEvent;
import jexer.event.TMenuEvent;
*/
public class TMenuItem extends TWidget {
+ // ------------------------------------------------------------------------
+ // Variables --------------------------------------------------------------
+ // ------------------------------------------------------------------------
+
/**
* Label for this menu item.
*/
*/
private int id = TMenu.MID_UNUSED;
- /**
- * Get the menu item ID.
- *
- * @return the id
- */
- public final int getId() {
- return id;
- }
-
/**
* When true, this item can be checked or unchecked.
*/
private boolean checkable = false;
- /**
- * Set checkable flag.
- *
- * @param checkable if true, this menu item can be checked/unchecked
- */
- public final void setCheckable(final boolean checkable) {
- this.checkable = checkable;
- }
-
/**
* When true, this item is checked.
*/
private MnemonicString mnemonic;
/**
- * Get the mnemonic string for this menu item.
- *
- * @return mnemonic string
+ * An optional 2-cell-wide picture/icon for this item.
*/
- public final MnemonicString getMnemonic() {
- return mnemonic;
- }
+ private int icon = -1;
- /**
- * Get a global accelerator key for this menu item.
- *
- * @return global keyboard accelerator, or null if no key is associated
- * with this item
- */
- public final TKeypress getKey() {
- return key;
- }
+ // ------------------------------------------------------------------------
+ // Constructors -----------------------------------------------------------
+ // ------------------------------------------------------------------------
/**
- * Set a global accelerator key for this menu item.
+ * Package private constructor.
*
- * @param key global keyboard accelerator
+ * @param parent parent widget
+ * @param id menu id
+ * @param x column relative to parent
+ * @param y row relative to parent
+ * @param label menu item title
*/
- public final void setKey(final TKeypress key) {
- this.key = key;
+ TMenuItem(final TMenu parent, final int id, final int x, final int y,
+ final String label) {
- if (key != null) {
- int newWidth = (label.length() + 4 + key.toString().length() + 2);
- if (newWidth > getWidth()) {
- setWidth(newWidth);
- }
- }
+ this(parent, id, x, y, label, -1);
}
/**
* @param x column relative to parent
* @param y row relative to parent
* @param label menu item title
+ * @param icon icon picture/emoji
*/
TMenuItem(final TMenu parent, final int id, final int x, final int y,
- final String label) {
+ final String label, final int icon) {
// Set parent and window
super(parent);
setY(y);
setHeight(1);
this.label = mnemonic.getRawLabel();
- setWidth(label.length() + 4);
+ if (parent.useIcons) {
+ setWidth(StringUtils.width(label) + 6);
+ } else {
+ setWidth(StringUtils.width(label) + 4);
+ }
this.id = id;
+ this.icon = icon;
// Default state for some known menu items
switch (id) {
}
+ // ------------------------------------------------------------------------
+ // Event handlers ---------------------------------------------------------
+ // ------------------------------------------------------------------------
+
/**
* Returns true if the mouse is currently on the menu item.
*
return false;
}
+ /**
+ * Handle mouse button releases.
+ *
+ * @param mouse mouse button release event
+ */
+ @Override
+ public void onMouseUp(final TMouseEvent mouse) {
+ if ((mouseOnMenuItem(mouse)) && (mouse.isMouse1())) {
+ dispatch();
+ return;
+ }
+ }
+
+ /**
+ * Handle keystrokes.
+ *
+ * @param keypress keystroke event
+ */
+ @Override
+ public void onKeypress(final TKeypressEvent keypress) {
+ if (keypress.equals(kbEnter)) {
+ dispatch();
+ return;
+ }
+
+ // Pass to parent for the things we don't care about.
+ super.onKeypress(keypress);
+ }
+
+ // ------------------------------------------------------------------------
+ // TWidget ----------------------------------------------------------------
+ // ------------------------------------------------------------------------
+
/**
* Draw a menu item with label.
*/
}
}
+ boolean useIcons = ((TMenu) getParent()).useIcons;
+
char cVSide = GraphicsChars.WINDOW_SIDE;
- getScreen().vLineXY(0, 0, 1, cVSide, background);
- getScreen().vLineXY(getWidth() - 1, 0, 1, cVSide, background);
+ vLineXY(0, 0, 1, cVSide, background);
+ vLineXY(getWidth() - 1, 0, 1, cVSide, background);
- getScreen().hLineXY(1, 0, getWidth() - 2, ' ', menuColor);
- getScreen().putStringXY(2, 0, mnemonic.getRawLabel(), menuColor);
+ hLineXY(1, 0, getWidth() - 2, ' ', menuColor);
+ putStringXY(2 + (useIcons ? 2 : 0), 0, mnemonic.getRawLabel(),
+ menuColor);
if (key != null) {
String keyLabel = key.toString();
- getScreen().putStringXY((getWidth() - keyLabel.length() - 2), 0,
+ putStringXY((getWidth() - StringUtils.width(keyLabel) - 2), 0,
keyLabel, menuColor);
}
- if (mnemonic.getShortcutIdx() >= 0) {
- getScreen().putCharXY(2 + mnemonic.getShortcutIdx(), 0,
- mnemonic.getShortcut(), menuMnemonicColor);
+ if (mnemonic.getScreenShortcutIdx() >= 0) {
+ putCharXY(2 + (useIcons ? 2 : 0) + mnemonic.getScreenShortcutIdx(),
+ 0, mnemonic.getShortcut(), menuMnemonicColor);
}
if (checked) {
assert (checkable);
- getScreen().putCharXY(1, 0, GraphicsChars.CHECK, menuColor);
+ putCharXY(1, 0, GraphicsChars.CHECK, menuColor);
}
+ if ((useIcons == true) && (icon != -1)) {
+ putCharXY(2, 0, icon, menuColor);
+ }
+ }
+ // ------------------------------------------------------------------------
+ // TMenuItem --------------------------------------------------------------
+ // ------------------------------------------------------------------------
+
+ /**
+ * Get the menu item ID.
+ *
+ * @return the id
+ */
+ public final int getId() {
+ return id;
}
/**
- * Dispatch event(s) due to selection or click.
+ * Set checkable flag.
+ *
+ * @param checkable if true, this menu item can be checked/unchecked
*/
- public void dispatch() {
- assert (isEnabled());
+ public final void setCheckable(final boolean checkable) {
+ this.checkable = checkable;
+ }
- getApplication().addMenuEvent(new TMenuEvent(id));
+ /**
+ * Get checkable flag.
+ *
+ * @return true if this menu item is both checkable and checked
+ */
+ public final boolean getChecked() {
+ return ((checkable == true) && (checked == true));
+ }
+
+ /**
+ * Set checked flag. Note that setting checked on an item checkable will
+ * do nothing.
+ *
+ * @param checked if true, and if this menu item is checkable, then
+ * getChecked() will return true
+ */
+ public final void setChecked(final boolean checked) {
if (checkable) {
- checked = !checked;
+ this.checked = checked;
+ } else {
+ this.checked = false;
}
}
/**
- * Handle mouse button releases.
+ * Get the mnemonic string for this menu item.
*
- * @param mouse mouse button release event
+ * @return mnemonic string
*/
- @Override
- public void onMouseUp(final TMouseEvent mouse) {
- if ((mouseOnMenuItem(mouse)) && (mouse.isMouse1())) {
- dispatch();
- return;
- }
+ public final MnemonicString getMnemonic() {
+ return mnemonic;
}
/**
- * Handle keystrokes.
+ * Get a global accelerator key for this menu item.
*
- * @param keypress keystroke event
+ * @return global keyboard accelerator, or null if no key is associated
+ * with this item
*/
- @Override
- public void onKeypress(final TKeypressEvent keypress) {
- if (keypress.equals(kbEnter)) {
- dispatch();
- return;
+ public final TKeypress getKey() {
+ return key;
+ }
+
+ /**
+ * Set a global accelerator key for this menu item.
+ *
+ * @param key global keyboard accelerator
+ */
+ public final void setKey(final TKeypress key) {
+ this.key = key;
+
+ if (key != null) {
+ int newWidth = (StringUtils.width(label) + 4 +
+ StringUtils.width(key.toString()) + 2);
+ if (((TMenu) getParent()).useIcons) {
+ newWidth += 2;
+ }
+ if (newWidth > getWidth()) {
+ setWidth(newWidth);
+ }
}
+ }
- // Pass to parent for the things we don't care about.
- super.onKeypress(keypress);
+ /**
+ * Get a picture/emoji icon for this menu item.
+ *
+ * @return the codepoint, or -1 if no icon is specified for this menu
+ * item
+ */
+ public final int getIcon() {
+ return icon;
+ }
+
+ /**
+ * Set a picture/emoji icon for this menu item.
+ *
+ * @param icon a codepoint, or -1 to unset the icon
+ */
+ public final void setIcon(final int icon) {
+ this.icon = icon;
+ }
+
+ /**
+ * Dispatch event(s) due to selection or click.
+ */
+ public void dispatch() {
+ assert (isEnabled());
+
+ getApplication().postMenuEvent(new TMenuEvent(id));
+ if (checkable) {
+ checked = !checked;
+ }
}
+
}
git://git.nikiroo.be / fanfix.git / blobdiff