tcMenuJavaAPI
Classes | Public Member Functions | List of all members
com.thecoderscorner.menu.domain.BooleanMenuItem Class Reference
Inheritance diagram for com.thecoderscorner.menu.domain.BooleanMenuItem:
com.thecoderscorner.menu.domain.MenuItem

Classes

enum  BooleanNaming
 

Public Member Functions

 BooleanMenuItem (String name, String varName, int id, int eepromAddress, String functionName, BooleanNaming naming, boolean readOnly, boolean localOnly, boolean visible, boolean staticInRam)
 
BooleanNaming getNaming ()
 
boolean equals (Object o)
 
int hashCode ()
 
void accept (MenuItemVisitor visitor)
 
- Public Member Functions inherited from com.thecoderscorner.menu.domain.MenuItem
 MenuItem (String name, String variableName, int id, int eepromAddress, String functionName, boolean readOnly, boolean localOnly, boolean visible, boolean staticDataInRAM)
 
String getName ()
 
boolean isReadOnly ()
 
int getId ()
 
boolean isLocalOnly ()
 
int getEepromAddress ()
 
String getFunctionName ()
 
String getVariableName ()
 
boolean isVisible ()
 
boolean hasChildren ()
 
boolean isStaticDataInRAM ()
 
String toString ()
 

Additional Inherited Members

- Protected Attributes inherited from com.thecoderscorner.menu.domain.MenuItem
final String name
 
final String variableName
 
final int id
 
final int eepromAddress
 
final String functionName
 
final boolean readOnly
 
final boolean localOnly
 
final boolean visible
 
final boolean staticDataInRAM
 

Detailed Description

A menu item that can only hold boolean values (true or false). The naming can be changed such that the boolean can be represented with different text. Rather than using the constructor use the BooleanMenuItemBuilder to build one.


Class Documentation

◆ com::thecoderscorner::menu::domain::BooleanMenuItem::BooleanNaming

enum com::thecoderscorner::menu::domain::BooleanMenuItem::BooleanNaming
Enumerator
CHECKBOX
ON_OFF
TRUE_FALSE
YES_NO

Member Function Documentation

◆ getNaming()

BooleanNaming com.thecoderscorner.menu.domain.BooleanMenuItem.getNaming ( )

returns the naming for this boolean, that describes how to render the true/false choice.

Returns
the possible naming schemes.

The documentation for this class was generated from the following file: