com.efiAnalytics.plugin.ecu.servers

Interface UiSettingServer

public interface UiSettingServer

Author:

Philip Tobin

Method Summary

Modifier and Type	Method and Description
void	disposeUiComponent(java.awt.Component component) must be called when finished with a UI component in order to properly clean up resources and subscriptions associate with this Object.
javax.swing.JComponent	getUiComponent(java.lang.String componentName) retrieves the UI Components used by TunerStudio for the named component The referenced name will be the name assigned in the ECU Definition (ini) file.
java.util.List<UiCurve>	getUiCurves() retrieves all Curves
java.util.List<java.lang.String>	getUiPanelNames() retrieves the defined names for all Panels, Tables and Curves
java.util.List<UiTable>	getUiTable() retrieves all Tables defined

Method Detail

getUiComponent

javax.swing.JComponent getUiComponent(java.lang.String componentName)

retrieves the UI Components used by TunerStudio for the named component The referenced name will be the name assigned in the ECU Definition (ini) file. This will return the proper setting for: - Parameters / Constants - CurveGraphs - Tables - Panels - Dialogs When finished with the Component, Please notify with disposeUiComponent(String componentName) in order for TunerStudio to perform the appropriate cleanup work It may seem returning a basic component limits the ability to interact with the setting UI directly, direct interaction should never be performed. To update a setting, the API's of ControllerAccess should be used, to be notified of a change to a setting, again the API's of ControllerAccess should be used. This insures that all components will be notified of any changes.

Parameters:

componentName - the name of a Panel, Table, Curve or Parameter

Returns:

a completely constructed and subscribed UI component

disposeUiComponent

void disposeUiComponent(java.awt.Component component)

must be called when finished with a UI component in order to properly clean up resources and subscriptions associate with this Object.

Parameters:

component - - the original component provided by getUiComponent(String componentName)

getUiPanelNames

java.util.List<java.lang.String> getUiPanelNames()

retrieves the defined names for all Panels, Tables and Curves

Returns:

List of all Panel and Dialogs defined in the ini

getUiCurves

java.util.List<UiCurve> getUiCurves()

retrieves all Curves

Returns:

list of all CurveGraphs defined

getUiTable

java.util.List<UiTable> getUiTable()

retrieves all Tables defined

Returns:

All tables defined for this configuration