Package org.springframework.shell.jline.tui.component.view.control

Class MenuView.MenuItem

java.lang.Object

org.springframework.shell.jline.tui.component.view.control.MenuView.MenuItem

Direct Known Subclasses:

MenuView.Menu

Enclosing class:

MenuView

public static class MenuView.MenuItem
extends Object

MenuView.MenuItem represents an item in a MenuView.

See Also:

• MenuView.Menu

Constructor Summary

Constructors

Modifier	Constructor	Description
	MenuItem(String title)	Construct menu item with a title.
protected	MenuItem(String title, List<MenuView.MenuItem> items)
protected	MenuItem(String title, MenuView.MenuItem[] items)
	MenuItem(String title, MenuView.MenuItemCheckStyle checkStyle)	Construct menu item with a title and a check style.
	MenuItem(String title, MenuView.MenuItemCheckStyle checkStyle, @Nullable Runnable action)	Construct menu item with a title, a check style and a runnable.
	MenuItem(String title, MenuView.MenuItemCheckStyle checkStyle, @Nullable Runnable action, boolean initialCheckState)	Construct menu item with a title, a check style, a runnable and initial checked state.

Method Summary

Modifier and Type	Method	Description
@Nullable Runnable	getAction()
@Nullable MenuView.MenuItemCheckStyle	getCheckStyle()	Gets a check style.
@Nullable List<MenuView.MenuItem>	getItems()	Gets sub menu items.
String	getTitle()	Get a title.
boolean	isInitialCheckState()	Gets initial check state.
static MenuView.MenuItem	of(String title)	Return a MenuView.MenuItem with a given title.
static MenuView.MenuItem	of(String title, MenuView.MenuItemCheckStyle checkStyle)	Return a MenuView.MenuItem with a given title and a check style.
static MenuView.MenuItem	of(String title, MenuView.MenuItemCheckStyle checkStyle, Runnable action)
static MenuView.MenuItem	of(String title, MenuView.MenuItemCheckStyle checkStyle, Runnable action, boolean initialCheckState)
void	setAction(Runnable action)

Methods inherited from class java.lang.Object

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

Constructor Details

MenuItem

public MenuItem(String title)

Construct menu item with a title.

Parameters:

title - the title

MenuItem

public MenuItem(String title,
 MenuView.MenuItemCheckStyle checkStyle)

Construct menu item with a title and a check style.

Parameters:

title - the title

checkStyle - the check style

MenuItem

public MenuItem(String title,
 MenuView.MenuItemCheckStyle checkStyle,
 @Nullable Runnable action)

Construct menu item with a title, a check style and a runnable.

Parameters:

title - the title

checkStyle - the check style

action - the action to run when item is chosen

MenuItem

public MenuItem(String title,
 MenuView.MenuItemCheckStyle checkStyle,
 @Nullable Runnable action,
 boolean initialCheckState)

Construct menu item with a title, a check style, a runnable and initial checked state.

Parameters:

title - the title

checkStyle - the check style

action - the action to run when item is chosen

initialCheckState - initial checked state

MenuItem

protected MenuItem(String title,
 MenuView.MenuItem[] items)

MenuItem

protected MenuItem(String title,
 List<MenuView.MenuItem> items)

Method Details

of

public static MenuView.MenuItem of(String title)

Return a MenuView.MenuItem with a given title.

Parameters:

title - the title

Returns:

a menu item

of

public static MenuView.MenuItem of(String title,
 MenuView.MenuItemCheckStyle checkStyle)

Return a MenuView.MenuItem with a given title and a check style.

Parameters:

title - the title

checkStyle - the check style

Returns:

a menu item

of

public static MenuView.MenuItem of(String title,
 MenuView.MenuItemCheckStyle checkStyle,
 Runnable action)

of

public static MenuView.MenuItem of(String title,
 MenuView.MenuItemCheckStyle checkStyle,
 Runnable action,
 boolean initialCheckState)

getAction

public @Nullable Runnable getAction()

setAction

public void setAction(Runnable action)

isInitialCheckState

public boolean isInitialCheckState()

Gets initial check state.

Returns:

initial check state

getTitle

public String getTitle()

Get a title. Never null, empty or just having white spaces.

Returns:

a title

getCheckStyle

public @Nullable MenuView.MenuItemCheckStyle getCheckStyle()

Gets a check style. This will be null if constructed via MenuView.Menu as style doesn't apply items being a sub-menu.

Returns:

a check style

getItems

public @Nullable List<MenuView.MenuItem> getItems()

Gets sub menu items. This will be null if not constructed via MenuView.Menu as plain MenuView.MenuItem can't have other items.

Returns:

a menu items