guiSET.core

Class MenuItem

java.lang.Object

guiSET.core.Control

guiSET.core.TextBased

guiSET.core.MenuItem

Direct Known Subclasses:

ContextMenu, MenuSeparator, MenuTextbox

public class MenuItem
extends TextBased

Basic brick for creating menus. Just add a new MenuBar to your Frame instance and add MenuItems to it. You can add other MenuItems to these and so on to create any structure of menu items. Also take a look at the MenuSeparator which provides a non-clickable and slim line for separating parts of the menu strip. There is only this one class for every position in the menu tree. MenuItems and MenuStrips can also be used to create menus that pop up when i.e. right-clicking on something. This is accomplished by creating a ToolStrip and adding items to it. The ToolStrip can be be shown by calling myToolStrip.show().

Nested Class Summary

Nested classes/interfaces inherited from class guiSET.core.Control

Control.Constants, Control.ImageMode, Control.Predicate, Control.Predicate1<T>, Control.Predicate2<T,U>, Control.RenderingMethod, Control.Setter<T>

Field Summary

Fields inherited from class guiSET.core.TextBased

FONT_SIZE, LINE_HEIGHT, TEXT_ALIGN, TEXT_ALIGN_Y, TEXT_COLOR

Fields inherited from class guiSET.core.Control

ALL, ANCHOR_INACTIVE, AUTOSIZE_BOTH, AUTOSIZE_HEIGHT, AUTOSIZE_NONE, AUTOSIZE_WIDTH, BACKGROUND_COLOR, BACKGROUND_COLORS, BORDER, BORDER_COLOR, BORDER_RADIUS, BORDER_WIDTH, BUFFERED_RENDERING, COLORS, defaultRenderingMethod, FILL, FIT, FIT_INSIDE, FOREGROUND_COLOR, HOVER_COLOR, MARGIN, MARGIN_BOTTOM, MARGIN_LEFT, MARGIN_RIGHT, MARGIN_TOP, name, OPACITY, PADDING, PADDING_BOTTOM, PADDING_LEFT, PADDING_RIGHT, PADDING_TOP, PERCENTAGE_MODE, PIXEL_MODE, PRESSED_COLOR, SPACING, TEXT_PROPERTIES, UNBUFFERED_RENDERING

Constructor Summary

Constructors

Constructor and Description
MenuItem()
MenuItem(java.lang.String text)
MenuItem(java.lang.String text, Control.Predicate selectCallback) Constructor for immediately setting text and a lambda function to call when this item is selected.
MenuItem(java.lang.String text, Control.Predicate selectCallback, Shortcut shortcut) Similar to #MenuItem(String, Predicate), but also provide a shortcut.
MenuItem(java.lang.String text, java.lang.String selectCallback) Constructor for immediately setting text and name of method to call when this item is selected.
MenuItem(java.lang.String text, java.lang.String selectCallback, Shortcut shortcut) Similar to MenuItem(String, String), but also provide a shortcut.
MenuItem(java.lang.String text, java.lang.String methodName, Shortcut shortcut, boolean strong) If strong set to true, then the shortcut might also be fired when a textbox has focus.

Method Summary

Modifier and Type	Method and Description
void	add(MenuItem... items) Add subitems for this item.
void	add(java.lang.String... strings) Create and add subitems for each text String passed.
void	clear() Remove all subitems.
void	close() Close this item/strip.
MenuItem	getItem(int index) Get item at given index.
Control[]	getItems() Get sub items.
int	getNumItems() Get number of sub items.
Shortcut	getShortcut()
void	insert(int position, MenuItem... items) Insert subitems at given position.
boolean	isChecked()
static void	parseMenu(java.lang.String menuString, ContextMenu contextMenu) Same as parseMenu(String, MenuBar) but for context menus.
static void	parseMenu(java.lang.String menuString, ContextMenu contextMenu, java.lang.String shortcutIntroduceSequence, java.lang.String callbackIntroduceSequence)
static void	parseMenu(java.lang.String menuString, MenuBar menubar) Parse a string as menu.
static void	parseMenu(java.lang.String menuString, MenuBar menubar, java.lang.String shortcutIntroduceSequence, java.lang.String callbackIntroduceSequence)
void	remove(Control item) Remove item.
void	remove(int index) Remove item at given index.
void	removeChildSelectListener()
void	removeSelectListener()
void	setChecked(boolean checked) MenuItems can be checked / unchecked with this method (little icon on the left of the MenuItem text).
void	setChildSelectListener(Control.Predicate lambda) Set a listener for when a child of this header has been selected.
void	setChildSelectListener(Control.Predicate1<MenuItem> lambda) Set a listener for when a child of this header has been selected.
void	setChildSelectListener(java.lang.String methodName)
void	setChildSelectListener(java.lang.String methodName, java.lang.Object target) Set a listener for when a child of this header has been selected.
void	setEnabled(boolean enabled) Set the enabled state of this element.
void	setSelectListener(Control.Predicate lambda) Set a listener lambda for when this item is selected.
void	setSelectListener(Control.Predicate1<MenuItem> lambda) Set a listener lambda for when this item is selected.
void	setSelectListener(java.lang.String methodName)
void	setSelectListener(java.lang.String methodName, java.lang.Object target) Set a listener for the item selected event (called when this item has been selected).
void	setShortcut(Shortcut shortcut) Set the displayed shortcut (shortcut has no real effect unless set manually at Frame).

Methods inherited from class guiSET.core.TextBased

copyStyle, getFont, getFontSize, getLineHeight, getText, getTextAlign, getTextAlignY, getTextColor, isBold, isItalic, isStrikethrough, isUnderlined, setBold, setFont, setFontSize, setForegroundColor, setItalic, setLineHeight, setLineHeightPercent, setStrikethrough, setText, setText, setTextAlign, setTextAlignY, setTextColor, setUnderlined

Methods inherited from class guiSET.core.Control

addAutoAnchors, animate, blur, copyStyle, doForAll, fillParent, fillParent, fillParent, fillParentHeight, fillParentHeight, fillParentWidth, fillParentWidth, focus, forceRepaint, getAnchorMode, getAnchorValue, getAvailableHeight, getAvailableWidth, getBackgroundColor, getBorderColor, getBorderRadius, getBorderWidth, getCursor, getForegroundColor, getHeight, getHoverColor, getImage, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOffsetXToParent, getOffsetXToWindow, getOffsetYToParent, getOffsetYToWindow, getOpacity, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getParent, getPressedColor, getVersionString, getWidth, getX, getY, getZ, isEnabled, isFocusable, isFocused, isPropagationStopped, isVisible, noAutosize, relativeCoordsAreWithin, removeAnchor, removeBoxShadow, removeFocusListener, removeMouseListener, removeResizeListener, setAnchor, setAnchors, setAutosizing, setBackgroundColor, setBorder, setBorder, setBorderColor, setBorderRadius, setBorderWidth, setBoxShadow, setCursor, setFixedSize, setFocusListener, setFocusListener, setFocusListener, setFocusListener, setGradient, setHeight, setHeight, setHoverColor, setImage, setImageMode, setMargin, setMargin, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseListener, setMouseListener, setMouseListener, setMouseListener, setOpacity, setOpacity, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPercentageAnchor, setPercentageAnchors, setPixelAnchor, setPixelAnchors, setPosition, setPressedColor, setResizeListener, setResizeListener, setResizeListener, setResizeListener, setSize, setVisibility, setVisible, setWidth, setWidth, setX, setY, setZ, stopPropagation, unfocus

Methods inherited from class java.lang.Object

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

Constructor Detail

MenuItem

public MenuItem()

MenuItem

public MenuItem(java.lang.String text)

MenuItem

public MenuItem(java.lang.String text,
                java.lang.String selectCallback)

Constructor for immediately setting text and name of method to call when this item is selected.

Parameters:

text - text

selectCallback - method name of callback for select event

MenuItem

public MenuItem(java.lang.String text,
                Control.Predicate selectCallback)

Constructor for immediately setting text and a lambda function to call when this item is selected.

Parameters:

text - text

selectCallback - lambda callback for select event

MenuItem

public MenuItem(java.lang.String text,
                java.lang.String selectCallback,
                Shortcut shortcut)

Similar to MenuItem(String, String), but also provide a shortcut. The shortcut is displayed on the menu item and when this shortcut is hit on the keyboard, the callback is executed as if the menu item had been pressed.

Parameters:

text - text

selectCallback - method name of callback for select event

shortcut - shortcut

MenuItem

public MenuItem(java.lang.String text,
                Control.Predicate selectCallback,
                Shortcut shortcut)

Similar to #MenuItem(String, Predicate), but also provide a shortcut. The shortcut is displayed on the menu item and when this shortcut is hit on the keyboard, the callback is executed as if the menu item had been pressed.

Parameters:

text - text

selectCallback - lambda callback for select event

shortcut - shortcut

MenuItem

public MenuItem(java.lang.String text,
                java.lang.String methodName,
                Shortcut shortcut,
                boolean strong)

If strong set to true, then the shortcut might also be fired when a textbox has focus.

Parameters:

text - text

methodName - method name

shortcut - shortcut

strong - strong property

Method Detail

close

public void close()

Close this item/strip. Recursively closes all subitems.

add

public void add(MenuItem... items)

Add subitems for this item.

Parameters:

items - newItems

add

public void add(java.lang.String... strings)

Create and add subitems for each text String passed. Passing an empty String will create a MenuSeparator.

Parameters:

strings - arbitrary number of text.

insert

public void insert(int position,
                   MenuItem... items)

Insert subitems at given position.

Parameters:

position - position

items - arbitrary number of items

clear

public void clear()

Remove all subitems.

remove

public void remove(int index)

Remove item at given index.

Parameters:

index - index of item to remove

remove

public void remove(Control item)

Remove item.

Parameters:

item - item to remove

getItems

public Control[] getItems()

Get sub items.

Returns:

sub items

getItem

public MenuItem getItem(int index)

Get item at given index.

Parameters:

index - index of item to get

Returns:

item

getNumItems

public int getNumItems()

Get number of sub items.

Returns:

number of sub items

setShortcut

public void setShortcut(Shortcut shortcut)

Set the displayed shortcut (shortcut has no real effect unless set manually at Frame).

Parameters:

shortcut - shortcut

getShortcut

public Shortcut getShortcut()

setChecked

public void setChecked(boolean checked)

MenuItems can be checked / unchecked with this method (little icon on the left of the MenuItem text).

Parameters:

checked - checked

isChecked

public boolean isChecked()

setEnabled

public void setEnabled(boolean enabled)

Description copied from class: Control

Set the enabled state of this element. If false it will not receive any events and be displayed in a different (mostly greyish) way.

Overrides:

setEnabled in class Control

Parameters:

enabled - enabled state

setSelectListener

public void setSelectListener(java.lang.String methodName,
                              java.lang.Object target)

Set a listener for the item selected event (called when this item has been selected). Event arguments: this MenuItem()

Parameters:

methodName - method name

target - target

setSelectListener

public void setSelectListener(java.lang.String methodName)

setSelectListener

public void setSelectListener(Control.Predicate1<MenuItem> lambda)

Set a listener lambda for when this item is selected. Event arguments: this MenuItem()

Parameters:

lambda - lambda expression with MenuItem() parameter

setSelectListener

public void setSelectListener(Control.Predicate lambda)

Set a listener lambda for when this item is selected. Event arguments: none

Parameters:

lambda - lambda expression

removeSelectListener

public void removeSelectListener()

setChildSelectListener

public void setChildSelectListener(java.lang.String methodName,
                                   java.lang.Object target)

Set a listener for when a child of this header has been selected. Event arguments: the selected child MenuItem()

Parameters:

methodName - method name

target - target

setChildSelectListener

public void setChildSelectListener(java.lang.String methodName)

setChildSelectListener

public void setChildSelectListener(Control.Predicate1<MenuItem> lambda)

Set a listener for when a child of this header has been selected. Event arguments: the selected child MenuItem()

Parameters:

lambda - lambda expression with MenuItem() parameter

setChildSelectListener

public void setChildSelectListener(Control.Predicate lambda)

Set a listener for when a child of this header has been selected. Event arguments: none

Parameters:

lambda - lambda expression

removeChildSelectListener

public void removeChildSelectListener()

parseMenu

public static void parseMenu(java.lang.String menuString,
                             MenuBar menubar)

Parse a string as menu. This can be a lot easier than creating a menu by hand. Items are wrapped by "<>" and start with their text, followed by an optional ":" after which the callback method comes. Finally a shortcut can be specified by starting with "-". The MenuParser is still a bit experimental, but seems to work so far. Examples:

"<File <New><Open><Recent <File 1><File 2><File3>><Save><Save As>> <Edit<Undo><Redo>>"

With shortcuts (different possibilities: separated by + or -; case does not matter; Ctrl is as valid as control or CONTROL etc.; SHIFT or shft etc.; order does not matter):

"<File <New -Ctrl+N><Open -Ctrl+O><Recent <File 1><File 2><File3>><Save -Ctrl-S><Save As -Ctrl-Shift-S>> <Edit<Undo -Control-Z><Redo -CONTROL+Y>>"

With callback method, executed when item is clicked or shortcut executed:

"<File <New:newFile -Ctrl+N><Open:openFile -Ctrl+O><Recent <File 1><File 2><File3>><Save -Ctrl-S><Save As -Ctrl-Shift-S>> <Edit<Undo:undo -Control-Z><Redo:redo -CONTROL+Y>>"

(given that the methods newFile() openFile() etc. have been declared) Shortcuts can also be given without giving a callback method and the other way round. The instruction sequences for starting the callback/shortcut details can be set by calling parseMenu(String, MenuBar, String, String) or parseMenu(String, ContextMenu, String, String).

Parameters:

menuString - string container menu coding information

menubar - the menu bar that the menus should be added to

parseMenu

public static void parseMenu(java.lang.String menuString,
                             MenuBar menubar,
                             java.lang.String shortcutIntroduceSequence,
                             java.lang.String callbackIntroduceSequence)

parseMenu

public static void parseMenu(java.lang.String menuString,
                             ContextMenu contextMenu)

Same as parseMenu(String, MenuBar) but for context menus.

Parameters:

menuString - string container menu coding information

contextMenu - the context menu that the menus should be added to

See Also:

parseMenu(String, MenuBar)

parseMenu

public static void parseMenu(java.lang.String menuString,
                             ContextMenu contextMenu,
                             java.lang.String shortcutIntroduceSequence,
                             java.lang.String callbackIntroduceSequence)