com.altair.hwm.interfaces
Interface ITCLCodeCreator

All Known Implementing Classes:

FEPreSelect, HMBoundingBox, HMEvalTCLProc, HMStart, HWMBaseButton, HWMButton, HWMCheckBox, HWMComboBox, HWMFileBrowser, HWMLabel, HWMListBox, HWMMinMaxIcon, HWMRadioButton, HWMSeparator, HWMSlider, HWMSpinner, HWMStartDB, HWMTextArea, HWMTextField

public interface ITCLCodeCreator

Title: ITCLCodeCreator

Description: The TCL CodeCreator interface will allow the beans to write itself as the equivalent TCL code. The bean will use the methods defined to generate the necesssary TCL for functioning in the HWPM mode. The methods implemented creates the UI, and all the necessary methods to needed for the TCL Task module. NOTE: The layout specific properties will get added to this later. Company: Altair Engineering, Inc.

Method Summary

java.lang.String	TCLCreateAdditionalEventProcs() This method rerurns the TCL statement string for any additional procedures that is requred for the bean.
java.lang.String	TCLCreateExec() This method returns the TCL statement string that performs the execution of script associated with the bean.
java.lang.String	TCLCreateGetDataFromDataModel() This method returns the TCL statement string that gets the data in the datamodel.
java.lang.String	TCLCreateMemberVariables() This method returns the TCL statement string for all the memeber variables referred by the bean in question.
java.lang.String	TCLCreateOnDataModelChanged() This method returns the TCL statement string that implements the functionlaity requred to handle the "OnDataModelChanged" event.
java.lang.String	TCLCreateSetDataInDataModel() This method returns the TCL statement string that sets the data in the datamodel.
java.lang.String	TCLCreateUI() This method returns the TCL statement string for creating the GUI for the bean in question.

Method Detail

TCLCreateUI

java.lang.String TCLCreateUI()
                             throws java.lang.Exception

This method returns the TCL statement string for creating the GUI for the bean in question.

Throws:

java.lang.Exception

TCLCreateMemberVariables

java.lang.String TCLCreateMemberVariables()
                                          throws java.lang.Exception

This method returns the TCL statement string for all the memeber variables referred by the bean in question. The code generated by this method goes in the "DisplayWnd" procedure of the task.

Throws:

java.lang.Exception

TCLCreateSetDataInDataModel

java.lang.String TCLCreateSetDataInDataModel()
                                             throws java.lang.Exception

This method returns the TCL statement string that sets the data in the datamodel. The code generated by this method goes in the SetDataInDataModel code of the Task.

Throws:

java.lang.Exception

TCLCreateGetDataFromDataModel

java.lang.String TCLCreateGetDataFromDataModel()
                                               throws java.lang.Exception

This method returns the TCL statement string that gets the data in the datamodel. The code generated by this method goes in the GetDataFromDataModel code of the Task. The bean in question will generate the equivalent TCL code.

Throws:

java.lang.Exception

TCLCreateExec

java.lang.String TCLCreateExec()
                               throws java.lang.Exception

This method returns the TCL statement string that performs the execution of script associated with the bean. The code generated goes into the "Exec" procedure of the task. The bean in question will generate the TCL code.

Throws:

java.lang.Exception

TCLCreateOnDataModelChanged

java.lang.String TCLCreateOnDataModelChanged()
                                             throws java.lang.Exception

This method returns the TCL statement string that implements the functionlaity requred to handle the "OnDataModelChanged" event. If the bean in question needs to be interested in updating itself, then the bean will be implementing the mthod to return the TCL code.

Throws:

java.lang.Exception

TCLCreateAdditionalEventProcs

java.lang.String TCLCreateAdditionalEventProcs()
                                               throws java.lang.Exception

This method rerurns the TCL statement string for any additional procedures that is requred for the bean. For e.g: In the case of a "Browse" button, there should be a "OnBrowseFile" procedure which is the callback for the "Browse" button. The TCL equivalent code ffor creating that proceudre will be returned by this methos. The bean in question will implement the required procediures code generation.

Throws:

java.lang.Exception