Shellfish

Class: MenuItemBase

ui.MenuItemBase

MenuItemBase.shui:38

Element representing the base class for menu items.

Properties:
Name Type Description
selected bool

[readonly] Whether the menu item is currently selected.
highlighted bool

[readonly] Whether the menu item is currently highlighted (not necessarily selected).
menu fengshui.Template

(default: null) A template for a submenu.
menuOpened bool

[readonly] Whether the submenu is currently opened.

Extends

Methods

closeMenu ()

MenuItemBase.shui:89

Closes the submenu.

hasSiblingMenuOpen ()bool

MenuItemBase.shui:112

Returns whether one of the sibling menu items has a submenu opened.

Returns:
Type Description
bool Whether a sibling menu item has a submenu opened.

selectItem (activate)

MenuItemBase.shui:103

Selects this menu item.

Name Type Description
activate bool

Whether the item should be activated to open its submenu.

showMenu ()

MenuItemBase.shui:82

Shows the submenu if there is one.

toSibling (direction, f)

MenuItemBase.shui:121

Directs a function to the previous or next sibling.

Name Type Description
direction number

If -1, targets the previous sibling. If 1, targets the next sibling.
f function

The function to execute. Takes the sibling instance as parameter.

unselectSiblings ()

MenuItemBase.shui:96

Unselects all sibling menu items.