com.thecoderscorner.menu.remote.RemoteControllerListener Interface Reference

Public Member Functions
void	menuItemChanged (MenuItem item, boolean valueOnly)
void	treeFullyPopulated ()
void	connectionState (RemoteInformation remoteInformation, AuthStatus connected)
void	ackReceived (CorrelationId key, MenuItem item, AckStatus status)
void	dialogUpdate (MenuDialogCommand cmd)

Detailed Description

This interface is implemented when you wish to receive update events from a RemoteMenuController. It gets called back when menu items are changed, the tree is fully populated or if the connectivity state changes. The implementation is then passed to the appropriate instance of RemoteMenuConnector via its addListener method.

Member Function Documentation

ackReceived()

void com.thecoderscorner.menu.remote.RemoteControllerListener.ackReceived	(	CorrelationId	key,
		MenuItem	item,
		AckStatus	status
	)

Indicates that an acknowledgment has been received from the embedded device.

Parameters

key	the correlation ID of the acknowledgement
item	the item it corresponds to (may be null)
status	the status associated with the ack.

connectionState()

void com.thecoderscorner.menu.remote.RemoteControllerListener.connectionState	(	RemoteInformation	remoteInformation,
		AuthStatus	connected
	)

Indicates a change in connectivity

Parameters

remoteInformation	the new connection information
connected	true if connected, otherwise false.

dialogUpdate()

void com.thecoderscorner.menu.remote.RemoteControllerListener.dialogUpdate

(

MenuDialogCommand

cmd

)

Called when a dialog event occurs on the remote, be it to show or hide a dialog

Parameters

cmd	the dialog command that has been received

menuItemChanged()

void com.thecoderscorner.menu.remote.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.

Parameters

item	the item that has changed
valueOnly	true if only the current value has changed, false if the MenuItem has changed too

treeFullyPopulated()

void com.thecoderscorner.menu.remote.RemoteControllerListener.treeFullyPopulated

(

)

Indicates that the tree is now fully populated, and therefore all menus that exist on the Arduino also exist locally in the MenuTree.

---

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

• src/main/java/com/thecoderscorner/menu/remote/RemoteControllerListener.java