Module com.thecoderscorner.tcmenu.javaapi

Package com.thecoderscorner.menu.domain.state

Interface AnyMenuState

All Known Implementing Classes:

BigDecimalMenuState, BooleanMenuState, CurrentScrollPositionMenuState, FloatMenuState, IntegerMenuState, MenuState, PortableColorMenuState, StringListMenuState, StringMenuState

public interface AnyMenuState

AnyMenuState represents any menu state of any type, it is a convenience that allows for non-generic access to a menu state of any type, where the type is not important. Generally it's best to work with state via MenuItemHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	AnyMenuState.StateStorageType	Represents the storage type for the state.

Method Summary

Modifier and Type	Method	Description
MenuItem	getItem()
AnyMenuState.StateStorageType	getStorageType()
Object	getValue()
boolean	isActive()
boolean	isChanged()

Method Details

getItem

MenuItem getItem()

Returns:

the item that this state belongs to

getValue

Object getValue()

Returns:

the current value of this item, you can get a more refined from the sub class methods

isChanged

boolean isChanged()

Returns:

true if the state has changed

isActive

boolean isActive()

Returns:

true if the state represents the active item

getStorageType

AnyMenuState.StateStorageType getStorageType()

Returns:

the type of data this menu state holds