Uses of Class
com.thecoderscorner.menu.domain.MenuItem

Packages that use MenuItem

Package	Description
com.thecoderscorner.menu.domain
com.thecoderscorner.menu.domain.state
com.thecoderscorner.menu.domain.util
com.thecoderscorner.menu.persist
com.thecoderscorner.menu.remote
com.thecoderscorner.menu.remote.commands

Uses of MenuItem in com.thecoderscorner.menu.domain

Classes in com.thecoderscorner.menu.domain with type parameters of type MenuItem

Modifier and Type	Class	Description
class	MenuItemBuilder<T extends MenuItemBuilder,M extends MenuItem>

Subclasses of MenuItem in com.thecoderscorner.menu.domain

Modifier and Type	Class	Description
class	ActionMenuItem	ActionMenuItem represents a menu item that is a one shot action, in that when triggered it just runs the callback on the embedded side.
class	AnalogMenuItem	Represents an analog (numeric) menu item, it is always a zero based integer when retrieved from storage, but it can have an offset and divisor, so therefore is able to represent decimal values.
class	BooleanMenuItem	A menu item that can only hold boolean values (true or false).
class	CustomBuilderMenuItem	This is a custom menu item that can be created by the designer, but does not directly represent a different item in the API.
class	EditableLargeNumberMenuItem	A menu item that corresponds to the large number type on the device.
class	EditableTextMenuItem	An implementation of menu item that can store text strings.
class	EnumMenuItem	A menu item implementation that represents one of a known set of choices, the choices are stored as an integer value, but each choice has a string representation as well.
class	FloatMenuItem	FloatMenuItem represents a menu item that uses a floating point value.
class	Rgb32MenuItem	A menu item that represents a colour in the RGB domain with optional Alpha channel.
class	RuntimeListMenuItem
class	ScrollChoiceMenuItem	Represents a more configurable and more extensible version of enum that should be used when the number of choices is larger, the choices are in eeprom, or you need more control at runtime of the choices.
class	SubMenuItem	SubMenuItem represents a menu item that has children.

Uses of MenuItem in com.thecoderscorner.menu.domain.state

Methods in com.thecoderscorner.menu.domain.state that return MenuItem

Modifier and Type	Method	Description
MenuItem	AnyMenuState.getItem()
MenuItem	MenuState.getItem()	Gets the menu item associated with this state.

Methods in com.thecoderscorner.menu.domain.state that return types with arguments of type MenuItem

Modifier and Type	Method	Description
Collection<MenuItem>	MenuTree.getAllMenuItems()	Gets every menu item held in this menu tree, will be unique
Set<MenuItem>	MenuTree.getAllSubMenus()	Returns all the submenus that are currently stored
Optional<MenuItem>	MenuTree.getMenuById(int id)	Gets the menu item with the specified ID, finding the submenu if needed.
List<MenuItem>	MenuTree.getMenuItems(MenuItem item)	Get a list of all menu items for a given submenu

Methods in com.thecoderscorner.menu.domain.state with parameters of type MenuItem

Modifier and Type	Method	Description
void	MenuTree.addMenuItem(SubMenuItem parent, MenuItem item)	add a new menu item to a sub menu, for the top level menu use ROOT.
void	MenuTree.addOrUpdateItem(int parentId, MenuItem item)	This will either add or update an existing item, depending if the ID is already present.
void	MenuTree.changeItem(MenuItem item, AnyMenuState menuState)	Change the value that's associated with a menu item.
SubMenuItem	MenuTree.findParent(MenuItem toFind)	Finds the submenu that the provided object belongs to.
List<MenuItem>	MenuTree.getMenuItems(MenuItem item)	Get a list of all menu items for a given submenu
<T extends AnyMenuState> T	MenuTree.getMenuState(MenuItem item)	Gets the menu state that's associated with a given menu item.
void	MenuTree.moveItem(SubMenuItem parent, MenuItem newItem, MenuTree.MoveType moveType)	Moves the item either up or down in the list for that submenu
void	MenuTree.removeMenuItem(MenuItem toRemove)	Remove the menu item using this menu item as a prototype (Uses the ID for comparison)
void	MenuTree.removeMenuItem(SubMenuItem parent, MenuItem item)	Remove the menu item for the provided menu item in the provided sub menu.
void	MenuTree.replaceMenuById(MenuItem toReplace)	Replace a menu item with the given ID.
void	MenuTree.replaceMenuById(SubMenuItem subMenu, MenuItem toReplace)	Replace the menu item that has a given parent with the one provided.

Constructors in com.thecoderscorner.menu.domain.state with parameters of type MenuItem

Modifier	Constructor	Description
	BigDecimalMenuState(MenuItem item, boolean changed, boolean active, BigDecimal value)	Creates a state that can store a big decimal
	BooleanMenuState(MenuItem item, boolean changed, boolean active, boolean value)
	CurrentScrollPositionMenuState(MenuItem item, boolean changed, boolean active, CurrentScrollPosition value)
	FloatMenuState(MenuItem item, boolean changed, boolean active, Float value)
	IntegerMenuState(MenuItem item, boolean changed, boolean active, Integer value)
	MenuState(AnyMenuState.StateStorageType storageType, MenuItem item, boolean changed, boolean active, T value)	normally these states are created from the menu item, instead of directly
	PortableColorMenuState(MenuItem item, boolean changed, boolean active, PortableColor value)
	StringListMenuState(MenuItem item, boolean changed, boolean active, String... value)
	StringListMenuState(MenuItem item, boolean changed, boolean active, List<String> value)
	StringMenuState(MenuItem item, boolean changed, boolean active, String value)

Uses of MenuItem in com.thecoderscorner.menu.domain.util

Methods in com.thecoderscorner.menu.domain.util that return MenuItem

Modifier and Type	Method	Description
static MenuItem	MenuItemHelper.createFromExistingWithId(MenuItem selected, int newId)	creates a copy of the menu item chosen, with the ID changed to newId

Methods in com.thecoderscorner.menu.domain.util with parameters of type MenuItem

Modifier and Type	Method	Description
void	AbstractMenuItemVisitor.anyItem(MenuItem item)	Whenever a visit method is not implemented, then anyItem is called instead.
static SubMenuItem	MenuItemHelper.asSubMenu(MenuItem item)	Returns the menu item as a sub menu or null
static MenuItem	MenuItemHelper.createFromExistingWithId(MenuItem selected, int newId)	creates a copy of the menu item chosen, with the ID changed to newId
static int	MenuItemHelper.eepromSizeForItem(MenuItem item)	Gets the size of the eeprom storage for a given element type
static String	MenuItemFormatter.formatForDisplay(MenuItem item, Object data)
static String	MenuItemFormatter.formatToWire(MenuItem item, String text)
static <T> T	MenuItemHelper.getValueFor(MenuItem item, MenuTree tree, T def)
static boolean	MenuItemHelper.isRuntimeStructureNeeded(MenuItem item)	Check if the item is based on a runtime item
static AnyMenuState	MenuItemHelper.stateForMenuItem(MenuItem item, Object val, boolean changed, boolean active)
static AnyMenuState	MenuItemHelper.stateForMenuItem(AnyMenuState existingState, MenuItem item, Object val)
static AnyMenuState	MenuItemHelper.stateForMenuItem(AnyMenuState existingState, MenuItem item, Object val, boolean changed)
static <T> Optional<T>	MenuItemHelper.visitWithResult(MenuItem item, AbstractMenuItemVisitor<T> visitor)	Visits a menu item calling the appropriate function for the type and collects the result that is set by calling your visitor's `setResult` method.

Uses of MenuItem in com.thecoderscorner.menu.persist

Methods in com.thecoderscorner.menu.persist that return MenuItem

Modifier and Type	Method	Description
MenuItem	PersistedMenu.getItem()

Methods in com.thecoderscorner.menu.persist with parameters of type MenuItem

Modifier and Type	Method	Description
String	JsonMenuItemSerializer.itemsToCopyText(MenuItem startingPoint, MenuTree tree)
void	PersistedMenu.setItem(MenuItem item)

Constructors in com.thecoderscorner.menu.persist with parameters of type MenuItem

Modifier	Constructor	Description
	PersistedMenu(MenuItem parent, MenuItem item)

Uses of MenuItem in com.thecoderscorner.menu.remote

Methods in com.thecoderscorner.menu.remote with parameters of type MenuItem

Modifier and Type	Method	Description
void	RemoteControllerListener.ackReceived(CorrelationId key, MenuItem item, AckStatus status)	Indicates that an acknowledgment has been received from the embedded device.
void	RemoteControllerListener.menuItemChanged(MenuItem item, boolean valueOnly)	Called when a menu item has either been added or changed, the valueOnly indicates if the change is just in the latest value, or also in the MenuItem structure too.
CorrelationId	RemoteMenuController.sendAbsoluteUpdate(MenuItem item, Object newValue)	Send an asbolute change for the given item
CorrelationId	RemoteMenuController.sendDeltaUpdate(MenuItem item, int deltaChange)	Send a delta change for the given menuitem

Uses of MenuItem in com.thecoderscorner.menu.remote.commands

Classes in com.thecoderscorner.menu.remote.commands with type parameters of type MenuItem

Modifier and Type	Class	Description
class	BootItemMenuCommand<T extends MenuItem,V>

Methods in com.thecoderscorner.menu.remote.commands with parameters of type MenuItem

Modifier and Type	Method	Description
static MenuChangeCommand	CommandFactory.newAbsoluteMenuChangeCommand(CorrelationId correlation, MenuItem item, Object value)	Creates a new absolute change command given the menu item and the absolute change in value.
static MenuChangeCommand	CommandFactory.newDeltaChangeCommand(CorrelationId correlation, MenuItem item, int value)	Creates a new delta change command given the menu item and the delta change in value.