jexer.menu

Class TMenu

java.lang.Object

jexer.TWidget

jexer.TWindow

jexer.menu.TMenu

All Implemented Interfaces:

java.lang.Comparable<TWidget>

public class TMenu
extends TWindow

TMenu is a top-level collection of TMenuItems.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MID_ABOUT
static int	MID_CASCADE
static int	MID_CLEAR
static int	MID_CLOSE_ALL
static int	MID_COPY
static int	MID_CUT
static int	MID_EXIT
static int	MID_FIND
static int	MID_GOTO_LINE
static int	MID_HELP_ACTIVE_FILE
static int	MID_HELP_CONTENTS
static int	MID_HELP_HELP
static int	MID_HELP_INDEX
static int	MID_HELP_PREVIOUS
static int	MID_HELP_SEARCH
static int	MID_NEW
static int	MID_OPEN_FILE
static int	MID_PASTE
static int	MID_QUIT
static int	MID_REPAINT
static int	MID_REPLACE
static int	MID_SCREEN_OPTIONS
static int	MID_SEARCH_AGAIN
static int	MID_SHELL
static int	MID_TABLE_BORDER_ALL
static int	MID_TABLE_BORDER_BOTTOM
static int	MID_TABLE_BORDER_CELL_ALL
static int	MID_TABLE_BORDER_CELL_NONE
static int	MID_TABLE_BORDER_DOUBLE_BOTTOM
static int	MID_TABLE_BORDER_LEFT
static int	MID_TABLE_BORDER_NONE
static int	MID_TABLE_BORDER_RIGHT
static int	MID_TABLE_BORDER_THICK_BOTTOM
static int	MID_TABLE_BORDER_TOP
static int	MID_TABLE_COLUMN_NARROW
static int	MID_TABLE_COLUMN_WIDEN
static int	MID_TABLE_DELETE_COLUMN
static int	MID_TABLE_DELETE_LEFT
static int	MID_TABLE_DELETE_ROW
static int	MID_TABLE_DELETE_UP
static int	MID_TABLE_FILE_OPEN_CSV
static int	MID_TABLE_FILE_SAVE_CSV
static int	MID_TABLE_FILE_SAVE_TEXT
static int	MID_TABLE_INSERT_ABOVE
static int	MID_TABLE_INSERT_BELOW
static int	MID_TABLE_INSERT_LEFT
static int	MID_TABLE_INSERT_RIGHT
static int	MID_TABLE_RENAME_COLUMN
static int	MID_TABLE_RENAME_ROW
static int	MID_TABLE_VIEW_COLUMN_LABELS
static int	MID_TABLE_VIEW_HIGHLIGHT_COLUMN
static int	MID_TABLE_VIEW_HIGHLIGHT_ROW
static int	MID_TABLE_VIEW_ROW_LABELS
static int	MID_TILE
static int	MID_UNUSED
static int	MID_VIEW_IMAGE
static int	MID_WINDOW_CLOSE
static int	MID_WINDOW_MOVE
static int	MID_WINDOW_NEXT
static int	MID_WINDOW_PREVIOUS
static int	MID_WINDOW_ZOOM

Fields inherited from class jexer.TWindow

ABSOLUTEXY, CENTERED, HIDEONCLOSE, inKeyboardResize, inWindowMove, inWindowResize, MODAL, mouse, NOCLOSEBOX, NOZOOMBOX, OVERRIDEMENU, RESIZABLE, statusBar

Constructor Summary

Constructors

Constructor and Description
TMenu(TApplication parent, int x, int y, java.lang.String label) Public constructor.

Method Summary

Modifier and Type	Method and Description
TMenuItem	addDefaultItem(int id) Convenience function to add one of the default menu items.
TMenuItem	addDefaultItem(int id, boolean enabled) Convenience function to add one of the default menu items.
TMenuItem	addItem(int id, java.lang.String label) Convenience function to add a menu item.
TMenuItem	addItem(int id, java.lang.String label, boolean enabled) Convenience function to add a menu item.
TMenuItem	addItem(int id, java.lang.String label, TKeypress key) Convenience function to add a custom menu item.
TMenuItem	addItem(int id, java.lang.String label, TKeypress key, boolean enabled) Convenience function to add a custom menu item.
void	addSeparator() Convenience function to add a menu separator.
TSubMenu	addSubMenu(java.lang.String title) Convenience function to add a sub-menu.
void	draw() Draw a top-level menu with title and menu items.
MnemonicString	getMnemonic() Get the mnemonic string.
int	getTitleX() Get the menu title X position.
void	onKeypress(TKeypressEvent keypress) Handle keystrokes.
void	onMouseDown(TMouseEvent mouse) Handle mouse button presses.
void	onMouseMotion(TMouseEvent mouse) Handle mouse movements.
void	onMouseUp(TMouseEvent mouse) Handle mouse button releases.
void	setTitleX(int titleX) Set the menu title X position.

Methods inherited from class jexer.TWindow

activate, addShortcutKeypress, center, clearShortcutKeypresses, close, getApplication, getBackground, getBorder, getBorderControls, getScreen, getStatusBar, getTitle, getZ, hasCloseBox, hasHiddenMouse, hasOverriddenMenu, hasZoomBox, hide, inMovements, isHidden, isModal, isShortcutKeypress, isShown, maximize, mouseOnClose, mouseOnMaximize, mouseOnResize, newStatusBar, onClose, onCommand, onFocus, onHide, onMenu, onPreClose, onResize, onShow, onUnfocus, removeShortcutKeypress, restore, setHiddenMouse, setMaximumWindowHeight, setMaximumWindowWidth, setMinimumWindowHeight, setMinimumWindowWidth, setTitle, setZ, show, stopMovements, toString

Methods inherited from class jexer.TWidget

activate, activate, activateAll, addButton, addCalendar, addCheckBox, addComboBox, addDirectoryList, addDirectoryList, addDirectoryList, addDirectoryList, addEditor, addField, addField, addField, addImage, addImage, addLabel, addLabel, addLabel, addLabel, addLabel, addLabel, addList, addList, addList, addList, addPanel, addPasswordField, addPasswordField, addPasswordField, addProgressBar, addRadioGroup, addSpinner, addSplitPane, addTable, addTable, addText, addText, addTreeViewWidget, addTreeViewWidget, compareTo, doRepaint, drawBox, drawBox, drawBoxShadow, fileOpenBox, fileOpenBox, fileOpenBox, fileOpenBox, fileSaveBox, getAbsoluteX, getAbsoluteY, getActiveChild, getAttrXY, getChildren, getCursorAbsoluteX, getCursorAbsoluteY, getCursorX, getCursorY, getHeight, getLayoutManager, getParent, getTheme, getWidth, getWindow, getX, getY, handleEvent, hLineXY, inputBox, inputBox, inputBox, isAbsoluteActive, isActive, isCursorVisible, isDrawable, isEnabled, isVisible, messageBox, messageBox, mouseWouldHit, onIdle, onMouseDoubleClick, putAll, putAttrXY, putAttrXY, putCharXY, putCharXY, putCharXY, putStringXY, putStringXY, remove, remove, remove, remove, removeAll, resetTabOrder, setActive, setCursorVisible, setCursorX, setCursorY, setDimensions, setEnabled, setHeight, setLayoutManager, setParent, setupForTWindow, setVisible, setWidth, setWindow, setX, setY, splitHorizontal, splitVertical, switchWidget, toPrettyString, toPrettyString, vLineXY

Methods inherited from class java.lang.Object

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

Field Detail

MID_UNUSED

public static final int MID_UNUSED

See Also:

Constant Field Values

MID_REPAINT

public static final int MID_REPAINT

See Also:

Constant Field Values

MID_VIEW_IMAGE

public static final int MID_VIEW_IMAGE

See Also:

Constant Field Values

MID_SCREEN_OPTIONS

public static final int MID_SCREEN_OPTIONS

See Also:

Constant Field Values

MID_NEW

public static final int MID_NEW

See Also:

Constant Field Values

MID_EXIT

public static final int MID_EXIT

See Also:

Constant Field Values

MID_QUIT

public static final int MID_QUIT

See Also:

Constant Field Values

MID_OPEN_FILE

public static final int MID_OPEN_FILE

See Also:

Constant Field Values

MID_SHELL

public static final int MID_SHELL

See Also:

Constant Field Values

MID_CUT

public static final int MID_CUT

See Also:

Constant Field Values

MID_COPY

public static final int MID_COPY

See Also:

Constant Field Values

MID_PASTE

public static final int MID_PASTE

See Also:

Constant Field Values

MID_CLEAR

public static final int MID_CLEAR

See Also:

Constant Field Values

MID_FIND

public static final int MID_FIND

See Also:

Constant Field Values

MID_REPLACE

public static final int MID_REPLACE

See Also:

Constant Field Values

MID_SEARCH_AGAIN

public static final int MID_SEARCH_AGAIN

See Also:

Constant Field Values

MID_GOTO_LINE

public static final int MID_GOTO_LINE

See Also:

Constant Field Values

MID_TILE

public static final int MID_TILE

See Also:

Constant Field Values

MID_CASCADE

public static final int MID_CASCADE

See Also:

Constant Field Values

MID_CLOSE_ALL

public static final int MID_CLOSE_ALL

See Also:

Constant Field Values

MID_WINDOW_MOVE

public static final int MID_WINDOW_MOVE

See Also:

Constant Field Values

MID_WINDOW_ZOOM

public static final int MID_WINDOW_ZOOM

See Also:

Constant Field Values

MID_WINDOW_NEXT

public static final int MID_WINDOW_NEXT

See Also:

Constant Field Values

MID_WINDOW_PREVIOUS

public static final int MID_WINDOW_PREVIOUS

See Also:

Constant Field Values

MID_WINDOW_CLOSE

public static final int MID_WINDOW_CLOSE

See Also:

Constant Field Values

MID_HELP_CONTENTS

public static final int MID_HELP_CONTENTS

See Also:

Constant Field Values

MID_HELP_INDEX

public static final int MID_HELP_INDEX

See Also:

Constant Field Values

MID_HELP_SEARCH

public static final int MID_HELP_SEARCH

See Also:

Constant Field Values

MID_HELP_PREVIOUS

public static final int MID_HELP_PREVIOUS

See Also:

Constant Field Values

MID_HELP_HELP

public static final int MID_HELP_HELP

See Also:

Constant Field Values

MID_HELP_ACTIVE_FILE

public static final int MID_HELP_ACTIVE_FILE

See Also:

Constant Field Values

MID_ABOUT

public static final int MID_ABOUT

See Also:

Constant Field Values

MID_TABLE_RENAME_ROW

public static final int MID_TABLE_RENAME_ROW

See Also:

Constant Field Values

MID_TABLE_RENAME_COLUMN

public static final int MID_TABLE_RENAME_COLUMN

See Also:

Constant Field Values

MID_TABLE_VIEW_ROW_LABELS

public static final int MID_TABLE_VIEW_ROW_LABELS

See Also:

Constant Field Values

MID_TABLE_VIEW_COLUMN_LABELS

public static final int MID_TABLE_VIEW_COLUMN_LABELS

See Also:

Constant Field Values

MID_TABLE_VIEW_HIGHLIGHT_ROW

public static final int MID_TABLE_VIEW_HIGHLIGHT_ROW

See Also:

Constant Field Values

MID_TABLE_VIEW_HIGHLIGHT_COLUMN

public static final int MID_TABLE_VIEW_HIGHLIGHT_COLUMN

See Also:

Constant Field Values

MID_TABLE_BORDER_NONE

public static final int MID_TABLE_BORDER_NONE

See Also:

Constant Field Values

MID_TABLE_BORDER_ALL

public static final int MID_TABLE_BORDER_ALL

See Also:

Constant Field Values

MID_TABLE_BORDER_CELL_NONE

public static final int MID_TABLE_BORDER_CELL_NONE

See Also:

Constant Field Values

MID_TABLE_BORDER_CELL_ALL

public static final int MID_TABLE_BORDER_CELL_ALL

See Also:

Constant Field Values

MID_TABLE_BORDER_RIGHT

public static final int MID_TABLE_BORDER_RIGHT

See Also:

Constant Field Values

MID_TABLE_BORDER_LEFT

public static final int MID_TABLE_BORDER_LEFT

See Also:

Constant Field Values

MID_TABLE_BORDER_TOP

public static final int MID_TABLE_BORDER_TOP

See Also:

Constant Field Values

MID_TABLE_BORDER_BOTTOM

public static final int MID_TABLE_BORDER_BOTTOM

See Also:

Constant Field Values

MID_TABLE_BORDER_DOUBLE_BOTTOM

public static final int MID_TABLE_BORDER_DOUBLE_BOTTOM

See Also:

Constant Field Values

MID_TABLE_BORDER_THICK_BOTTOM

public static final int MID_TABLE_BORDER_THICK_BOTTOM

See Also:

Constant Field Values

MID_TABLE_DELETE_LEFT

public static final int MID_TABLE_DELETE_LEFT

See Also:

Constant Field Values

MID_TABLE_DELETE_UP

public static final int MID_TABLE_DELETE_UP

See Also:

Constant Field Values

MID_TABLE_DELETE_ROW

public static final int MID_TABLE_DELETE_ROW

See Also:

Constant Field Values

MID_TABLE_DELETE_COLUMN

public static final int MID_TABLE_DELETE_COLUMN

See Also:

Constant Field Values

MID_TABLE_INSERT_LEFT

public static final int MID_TABLE_INSERT_LEFT

See Also:

Constant Field Values

MID_TABLE_INSERT_RIGHT

public static final int MID_TABLE_INSERT_RIGHT

See Also:

Constant Field Values

MID_TABLE_INSERT_ABOVE

public static final int MID_TABLE_INSERT_ABOVE

See Also:

Constant Field Values

MID_TABLE_INSERT_BELOW

public static final int MID_TABLE_INSERT_BELOW

See Also:

Constant Field Values

MID_TABLE_COLUMN_NARROW

public static final int MID_TABLE_COLUMN_NARROW

See Also:

Constant Field Values

MID_TABLE_COLUMN_WIDEN

public static final int MID_TABLE_COLUMN_WIDEN

See Also:

Constant Field Values

MID_TABLE_FILE_OPEN_CSV

public static final int MID_TABLE_FILE_OPEN_CSV

See Also:

Constant Field Values

MID_TABLE_FILE_SAVE_CSV

public static final int MID_TABLE_FILE_SAVE_CSV

See Also:

Constant Field Values

MID_TABLE_FILE_SAVE_TEXT

public static final int MID_TABLE_FILE_SAVE_TEXT

See Also:

Constant Field Values

Constructor Detail

TMenu

public TMenu(TApplication parent,
             int x,
             int y,
             java.lang.String label)

Public constructor.

Parameters:

parent - parent application

x - column relative to parent

y - row relative to parent

label - mnemonic menu title. Label must contain a keyboard shortcut (mnemonic), denoted by prefixing a letter with "&", e.g. "&File"

Method Detail

onMouseDown

public void onMouseDown(TMouseEvent mouse)

Handle mouse button presses.

Overrides:

onMouseDown in class TWindow

Parameters:

mouse - mouse button event

onMouseUp

public void onMouseUp(TMouseEvent mouse)

Handle mouse button releases.

Overrides:

onMouseUp in class TWindow

Parameters:

mouse - mouse button release event

onMouseMotion

public void onMouseMotion(TMouseEvent mouse)

Handle mouse movements.

Overrides:

onMouseMotion in class TWindow

Parameters:

mouse - mouse motion event

onKeypress

public void onKeypress(TKeypressEvent keypress)

Handle keystrokes.

Overrides:

onKeypress in class TWindow

Parameters:

keypress - keystroke event

draw

public void draw()

Draw a top-level menu with title and menu items.

Overrides:

draw in class TWindow

setTitleX

public void setTitleX(int titleX)

Set the menu title X position.

Parameters:

titleX - the position

getTitleX

public int getTitleX()

Get the menu title X position.

Returns:

the position

getMnemonic

public MnemonicString getMnemonic()

Get the mnemonic string.

Returns:

the full mnemonic string

addItem

public TMenuItem addItem(int id,
                         java.lang.String label)

Convenience function to add a menu item.

Parameters:

id - menu item ID. Must be greater than 1024.

label - menu item label

Returns:

the new menu item

addItem

public TMenuItem addItem(int id,
                         java.lang.String label,
                         boolean enabled)

Convenience function to add a menu item.

Parameters:

id - menu item ID. Must be greater than 1024.

label - menu item label

enabled - default state for enabled

Returns:

the new menu item

addItem

public TMenuItem addItem(int id,
                         java.lang.String label,
                         TKeypress key)

Convenience function to add a custom menu item.

Parameters:

id - menu item ID. Must be greater than 1024.

label - menu item label

key - global keyboard accelerator

Returns:

the new menu item

addItem

public TMenuItem addItem(int id,
                         java.lang.String label,
                         TKeypress key,
                         boolean enabled)

Convenience function to add a custom menu item.

Parameters:

id - menu item ID. Must be greater than 1024.

label - menu item label

key - global keyboard accelerator

enabled - default state for enabled

Returns:

the new menu item

addDefaultItem

public TMenuItem addDefaultItem(int id)

Convenience function to add one of the default menu items.

Parameters:

id - menu item ID. Must be between 0 (inclusive) and 1023 (inclusive).

Returns:

the new menu item

addDefaultItem

public TMenuItem addDefaultItem(int id,
                                boolean enabled)

Convenience function to add one of the default menu items.

Parameters:

id - menu item ID. Must be between 0 (inclusive) and 1023 (inclusive).

enabled - default state for enabled

Returns:

the new menu item

addSeparator

public void addSeparator()

Convenience function to add a menu separator.

addSubMenu

public TSubMenu addSubMenu(java.lang.String title)

Convenience function to add a sub-menu.

Parameters:

title - menu title. Title must contain a keyboard shortcut, denoted by prefixing a letter with "&", e.g. "&File"

Returns:

the new sub-menu