Module com.thecoderscorner.tcmenu.javaapi

Package com.thecoderscorner.menu.domain

Class TextMenuItem

java.lang.Object

com.thecoderscorner.menu.domain.MenuItem<java.lang.String>

com.thecoderscorner.menu.domain.TextMenuItem

public class TextMenuItem
extends MenuItem<java.lang.String>

An implementation of menu item that can store text strings. Currently, the are always stored in RAM on the Arduino so choose the size carefully.

Field Summary

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

eepromAddress, functionName, id, name, readOnly

Constructor Summary

Constructors

Constructor	Description
TextMenuItem()
TextMenuItem(java.lang.String name, int id, int eepromAddress, java.lang.String functionName, int length, boolean readOnly)

Method Summary

Modifier and Type	Method	Description
void	accept(MenuItemVisitor visitor)
boolean	equals(java.lang.Object o)
int	getTextLength()	The maximum length allowable.
int	hashCode()
MenuState<java.lang.String>	newMenuState(java.lang.String value, boolean changed, boolean active)	Returns a new String current value that can be used as the current value in the Menutree

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

getEepromAddress, getFunctionName, getId, getName, hasChildren, isReadOnly, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TextMenuItem

public TextMenuItem()

TextMenuItem

public TextMenuItem(java.lang.String name,
                    int id,
                    int eepromAddress,
                    java.lang.String functionName,
                    int length,
                    boolean readOnly)

Method Detail

getTextLength

public int getTextLength()

The maximum length allowable.

Returns:

newMenuState

public MenuState<java.lang.String> newMenuState(java.lang.String value,
                                                boolean changed,
                                                boolean active)

Returns a new String current value that can be used as the current value in the Menutree

Specified by:

newMenuState in class MenuItem<java.lang.String>

Parameters:

value - the new value

changed - if the value has changed

active - if the value is active.

Returns:

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

accept

public void accept(MenuItemVisitor visitor)

Specified by:

accept in class MenuItem<java.lang.String>