com.thecoderscorner.embedcontrol.core.controlmgr.EditorComponent< T > Interface Template Reference

Classes
enum	PortableAlignment
enum	RenderingStatus

Public Member Functions
void	onItemUpdated (MenuState<?> newValue)
void	structuralChange (MenuItem item)
void	onCorrelation (CorrelationId correlationId, AckStatus status)
void	tick ()
T	createComponent ()

Detailed Description

This interface represents an item that can be drawn onto a display, it does not say what the control should be directly, the control is created by a call to createComponent, which generates the required UI node.

Parameters

<T>	the base node type for the UI

---

Class Documentation

com::thecoderscorner::embedcontrol::core::controlmgr::EditorComponent::PortableAlignment

enum com::thecoderscorner::embedcontrol::core::controlmgr::EditorComponent::PortableAlignment

The possible alignments for the items within the control

Enumerator
CENTER
LEFT
RIGHT

com::thecoderscorner::embedcontrol::core::controlmgr::EditorComponent::RenderingStatus

enum com::thecoderscorner::embedcontrol::core::controlmgr::EditorComponent::RenderingStatus

The rendering statuses that the control can be in, to indicate in progress, recent updates or even an error

Enumerator
CORRELATION_ERROR
EDIT_IN_PROGRESS
NORMAL
RECENT_UPDATE

Member Function Documentation

createComponent()

T com.thecoderscorner.embedcontrol.core.controlmgr.EditorComponent< T >.createComponent

(

)

Create the underlying UI component that represents this menu item. This should be called once per item grid population only

Returns

the UI node

onCorrelation()

void com.thecoderscorner.embedcontrol.core.controlmgr.EditorComponent< T >.onCorrelation	(	CorrelationId	correlationId,
		AckStatus	status
	)

A correlation has been received from the remote and needs processing

Parameters

correlationId	the correlation ID, possibly EMPTY_CORRELATION
status	the acknowledgement status

onItemUpdated()

void com.thecoderscorner.embedcontrol.core.controlmgr.EditorComponent< T >.onItemUpdated

(

MenuState<?>

newValue

)

The item has been updated to a new value and that value needs to be presented

Parameters

newValue

the menu state containing the update

structuralChange()

void com.thecoderscorner.embedcontrol.core.controlmgr.EditorComponent< T >.structuralChange

(

MenuItem

item

)

There has been a structural change that requires the item to be recalculated.

Parameters

item	the replacement item after a structural update.

tick()

void com.thecoderscorner.embedcontrol.core.controlmgr.EditorComponent< T >.tick

(

)

Should be called frequently to allow the momentary rendering statuses to be cleared, usually called 1/10 sec by the TreeComponentManager in most systems. Do not do anything here that locks or takes time. It is not called on the UI thread.

---

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

• src/main/java/com/thecoderscorner/embedcontrol/core/controlmgr/EditorComponent.java