|
FUNCTION ConfigGuiDisplay() |
Standard initialization of graphical environment for the view
|
|
FUNCTION ConfigGuiDisplay(allowDialogueWindows) |
Standard initialization of graphical environment for the view
|
| Parameter | Description |
|---|
| allowDialogueWindows |
A simple boolean to allow dialogue windows to display outside of Eclipse view (0=No, 1=Yes) |
|
|
FUNCTION GetFontInfo(option$, name$, size) |
Get information about the specified system font type
|
| Parameter | Description |
|---|
| option$ |
A single letter to identify the font type |
| name$ |
Name of current font of specified type |
| size |
Size of current font of specified type |
|
| Returns |
0=No Font infomration found, 1=Found font information |
|
| Font Type Codes |
|---|
| Value | Description |
|---|
| G |
Graphical Font |
| T |
Text plane font |
|
|
FUNCTION GetInfo$(option$) |
Get information about the current Eclipse working environment
|
| Parameter | Description |
|---|
| option$ |
A single letter to identify the information required. |
|
| Returns |
The value for the requested information. |
|
| Information Codes |
|---|
| Value | Description |
|---|
| E |
The current editor resource |
| N |
The number of selected resources in the Navigator View |
| P |
The current project |
| W |
The workspace name |
|
|
FUNCTION GetPath$(option$) |
Get the specified path
|
| Parameter | Description |
|---|
| option$ |
A single letter code to identify the path |
|
| Returns |
The value for the path. |
|
| Path Identification Codes |
|---|
| Value | Description |
|---|
| O |
The location of the output directory for the current project |
| P |
The current project location |
| S |
The location of the source directory for the current project |
| W |
The location of the current workspace |
|
|
FUNCTION GetWorkspaceRoot$() |
Get Workspace Root Path
|
|
FUNCTION InitStage(stage) |
Perform initialization steps for specified stage; will also check environment variable PP4E_CT_DEBUG for and initiate debug action(s)
|
| Parameter | Description |
|---|
| stage |
Contributed tool startup stage |
|
| Contributed tool Startup Stage |
|---|
| Value | Description |
|---|
| StageActionPerformed |
1 Action Performed method (in listener) |
| StageProcessPanel |
2 Process Panel (in ecCommon) |
| StageTaskStart |
3 Task startup (ecCommonStartup) |
|
|
FUNCTION isPluginLoaded(aPluginID$) |
Check to see if the MAS plug-in has been loaded
aPluginID$ The ID of the dependent plug-in to be checked
|
| Returns |
A simple boolean (0=false, 1=true) to indicate whether the dependent Plug-in has been loaded |
|
|
FUNCTION OSisWindows() |
A simple check to determine if application is executing on a MS-Windows operating system.
|
| Returns |
A simple boolean to indicate that operating is MS-Windows |
|
|
FUNCTION Prefs(option$, tag$, value$) |
Access / modify preferences stored in the Eclipse Preference store
|
| Parameter | Description |
|---|
| option$ |
A code to indication the action to perform |
| tag$ |
The preference (or preference prefix) |
| value$ |
The value to be returned for a preference, or the value to set for the preference, or the maximum number for the preferences to be cleared |
|
| Returns |
See 'Action Code' table |
|
| Action Codes |
|---|
| Value | Description |
|---|
| C |
Clear a series of preferences that are prefixed by TAG$ and include a numeric counter that starts at one. The return value will be the number of preferences that have been cleared |
| G |
Get the value of the preference. The return value will be a 1 of there is a value. |
| S |
Set the value of the preference. The return value will be a 1 if the assignment was successful. |
|
|
FUNCTION processPanel(cUI$, cTitle$) |
|
FUNCTION processPanel(cUI$, cTitle$, aDataRec$) |
Standard mechanism to process a NOMADS panel in a view (in a separate process)
|
| Parameter | Description |
|---|
| cUI$ |
A NOMADS OOP class for the user interface |
| cTitle$ |
The panel title |
| aDataRec$ |
(Optional) A data record (SEP as field separator) to be seprated into variables and passed as arguments to the constructor of the class |
|
|
FUNCTION Resource(option$, path$) |
Get the location of the specified resource
|
| Parameter | Description |
|---|
| option$ |
A code to identify the view for the selected resource |
| path$ |
The path of the selected resource is returned in this variable |
|
| Returns |
A simple boolean to indicate that the method succeeded |
|
| View Codes |
|---|
| Value | Description |
|---|
| E |
The current resource loaded in the editor |
| N |
The resource selected in the Navigator View |
|
|
FUNCTION runProgram(aProgram$, cTitle$) |
|
FUNCTION runProgram(aProgram$, cTitle$, aDataRec$) |
|
FUNCTION runProgram(aProgram$, cTitle$, aDataRec$, aVarList$) |
Standard mechanism to run a program within a view (in a separate process)
|
| Parameter | Description |
|---|
| aProgram$ |
The name of a program to execute |
| cTitle$ |
The title for the application window |
| aDataRec$ |
(Optional) A data record to be passed to application program |
| aVarList$ |
(Optional) A list of variables to be assigned the values in aDataRec$ |
|
|
FUNCTION WorkFile$(prefix$, path$, ext$) |
Get the name for a work file.
|
| Parameter | Description |
|---|
| prefix$ |
A prefix to be used when creating the name for the work file. |
| path$ |
An optional path for the work file; if not specified, the operating system temporary directory will be used |
| ext$ |
An optional file extension to be used for the work file; if none is specified, "tmp" will be used |
|
| Returns |
The full path name of a work file that can be created by the application. |
|
