Module com.thecoderscorner.tcmenu.javaapi

Package com.thecoderscorner.menu.domain

Class RuntimeListMenuItem

java.lang.Object

com.thecoderscorner.menu.domain.MenuItem

com.thecoderscorner.menu.domain.RuntimeListMenuItem

public class RuntimeListMenuItem
extends MenuItem

This class represents a runtime list menu item, which is a type of menu item that can contain a list of values. It extends the MenuItem class and inherits its properties and methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RuntimeListMenuItem.ListCreationMode

Field Summary

Fields inherited from class com.thecoderscorner.menu.domain.MenuItem

eepromAddress, functionName, id, localOnly, name, readOnly, staticDataInRAM, variableName, visible

Constructor Summary

Constructors

Constructor	Description
RuntimeListMenuItem()
RuntimeListMenuItem(String name, String varName, int id, int eepromAddress, String functionName, boolean readOnly, boolean localOnly, boolean visible, int initialRows, boolean staticInRam, RuntimeListMenuItem.ListCreationMode creationMode)

Method Summary

Modifier and Type	Method	Description
void	accept(MenuItemVisitor visitor)	Used with MenuItemHelper's visit method, accepts a MenuItemVisitor and calls the appropriate visit method for a RuntimeListMenuItem.
boolean	equals(Object o)
int	getInitialRows()
List<String>	getItemsFromTree(MenuTree menuTree)	Retrieves the list of items from a menu tree for a specific RuntimeListMenuItem.
RuntimeListMenuItem.ListCreationMode	getListCreationMode()
int	hashCode()

Methods inherited from class com.thecoderscorner.menu.domain.MenuItem

getEepromAddress, getFunctionName, getId, getName, getVariableName, hasChildren, isLocalOnly, isReadOnly, isStaticDataInRAM, isVisible, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RuntimeListMenuItem

public RuntimeListMenuItem()

RuntimeListMenuItem

public RuntimeListMenuItem(String name,
 String varName,
 int id,
 int eepromAddress,
 String functionName,
 boolean readOnly,
 boolean localOnly,
 boolean visible,
 int initialRows,
 boolean staticInRam,
 RuntimeListMenuItem.ListCreationMode creationMode)

Method Details

getListCreationMode

public RuntimeListMenuItem.ListCreationMode getListCreationMode()

getInitialRows

public int getInitialRows()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

accept

public void accept(MenuItemVisitor visitor)

Used with MenuItemHelper's visit method, accepts a MenuItemVisitor and calls the appropriate visit method for a RuntimeListMenuItem.

Specified by:

accept in class MenuItem

Parameters:

visitor - The MenuItemVisitor to accept

getItemsFromTree

public List<String> getItemsFromTree(MenuTree menuTree)

Retrieves the list of items from a menu tree for a specific RuntimeListMenuItem. This is a helper to get back the list of items stored in the tree state.

Parameters:

menuTree - the menu tree from which to retrieve the items

Returns:

a list of items as strings