Module com.googlecode.lanterna

Package com.googlecode.lanterna.gui2.menu

Class Menu

java.lang.Object

com.googlecode.lanterna.gui2.AbstractComponent<MenuItem>

com.googlecode.lanterna.gui2.AbstractInteractableComponent<MenuItem>

com.googlecode.lanterna.gui2.menu.MenuItem

com.googlecode.lanterna.gui2.menu.Menu

All Implemented Interfaces:

Component, Interactable, TextGUIElement

public class Menu
extends MenuItem

Implementation of a drop-down menu contained in a MenuBar and also a sub-menu inside another Menu.

Nested Class Summary

Nested classes/interfaces inherited from class com.googlecode.lanterna.gui2.menu.MenuItem

MenuItem.DefaultMenuItemRenderer, MenuItem.MenuItemRenderer

Nested classes/interfaces inherited from interface com.googlecode.lanterna.gui2.Interactable

Interactable.FocusChangeDirection, Interactable.Result

Field Summary

Fields

Modifier and Type	Field	Description
private final List<MenuItem>	subItems

Constructor Summary

Constructors

Constructor	Description
Menu(String label)	Creates a menu with the specified label

Method Summary

Modifier and Type	Method	Description
Menu	add(MenuItem menuItem)	Adds a new menu item to this menu, this can be either a regular MenuItem or another Menu
protected boolean	onActivated()	Method to invoke when a menu item is "activated" by pressing the Enter key.

Methods inherited from class com.googlecode.lanterna.gui2.menu.MenuItem

createDefaultRenderer, getLabel, handleKeyStroke

Methods inherited from class com.googlecode.lanterna.gui2.AbstractInteractableComponent

afterEnterFocus, afterLeaveFocus, getCursorLocation, getInputFilter, getRenderer, handleInput, isActivationStroke, isEnabled, isFocusable, isFocused, isKeyboardActivationStroke, isMouseActivationStroke, isMouseDown, isMouseDrag, isMouseMove, isMouseUp, onEnterFocus, onLeaveFocus, setEnabled, setInputFilter, takeFocus

Methods inherited from class com.googlecode.lanterna.gui2.AbstractComponent

addTo, calculatePreferredSize, draw, getBasePane, getGlobalPosition, getLayoutData, getParent, getPosition, getPreferredSize, getSize, getTextGUI, getTheme, getThemeDefinition, hasParent, invalidate, isInside, isInvalid, isVisible, onAdded, onAfterDrawing, onBeforeDrawing, onRemoved, runOnGUIThreadIfExistsOtherwiseRunDirect, self, setLayoutData, setPosition, setPreferredSize, setRenderer, setSize, setTheme, setVisible, toBasePane, toGlobal, withBorder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.googlecode.lanterna.gui2.Component

addTo, getBasePane, getGlobalPosition, getLayoutData, getParent, getPosition, getPreferredSize, getSize, getTextGUI, getTheme, getThemeDefinition, hasParent, invalidate, isInside, isVisible, onAdded, onRemoved, setLayoutData, setPosition, setPreferredSize, setSize, setTheme, setVisible, toBasePane, toGlobal, withBorder

Methods inherited from interface com.googlecode.lanterna.gui2.TextGUIElement

draw, isInvalid

Field Details

subItems

private final List<MenuItem> subItems

Constructor Details

Menu

public Menu(String label)

Creates a menu with the specified label

Parameters:

label - Label to use for the menu item that will trigger this menu to pop up

Method Details

add

public Menu add(MenuItem menuItem)

Adds a new menu item to this menu, this can be either a regular MenuItem or another Menu

Parameters:

menuItem - The item to add to this menu

Returns:

Itself

onActivated

protected boolean onActivated()

Description copied from class: MenuItem

Method to invoke when a menu item is "activated" by pressing the Enter key.

Overrides:

onActivated in class MenuItem

Returns:

Returns true if the action was performed successfully, otherwise false, which will not automatically close the popup window itself.