EmbeddedJSAFSDriver (SAFS API DOCUMENT)

java.lang.Object
- org.safs.model.examples.advanced.EmbeddedJSAFSDriver

```
public class EmbeddedJSAFSDriver
extends java.lang.Object
```
This class attempts to demonstrate how ANY Java application can be made to exploit Driver--the Java API for SAFS testing.
The class does NOT subclass any existing SAFS class like DefaultDriver.
Instead, the class instantiates a reference to a JSAFSDriver that handles all the interfacing with SAFS for the developer. The JSAFSDriver will expect a Java System property to point to the INI file it would use for initialization. Like:
-Dsafs.project.config="pathTo\Driver.INI"
In this example, the JSAFSDriver is initialized in main(String[]) when this EmbeddedJSAFSDriver class is executed in the JVM.
This example also show how one might reuse the same Java classes for NLS testing by passing in parameters for the primary and localized App Maps (Resources) to be used for testing.
Example -D System Properties set during command-line invocation:
-Dmain_map="MyMainApp.map" -Dlocal_map="MyLocalApp_en.map" or
-Dmain_map="MyMainApp.map" -Dlocal_map="MyLocalApp_zh_CN.map"

Author:

Carl Nagle

Field Summary

Fields
Modifier and Type	Field and Description
`JSAFSDriver`	`jsafs` A readily accessible reference to the instantiated JSAFSDriver used by the test.
`static java.lang.String`	`LOCAL_MAP` "local_map"
`static EditBox`	`Login_Password` Optional `EditBox` reference to our Login Password field To be used when a `Component` reference might be desired instead of a String name.
`static PushButton`	`Login_Submit` Optional `PushButton` reference to our Login Submit button To be used when a `Component` reference might be desired instead of a String name.
`static EditBox`	`Login_UserID` Optional `EditBox` reference to our Login UserID field To be used when a `Component` reference might be desired instead of a String name.
`static java.lang.String`	`LoginPassword` "LoginPassword" App Map component name for Login Window Password EditBox To be used when the String name of the component is needed.
`static java.lang.String`	`LoginSubmit` "LoginSubmit" App Map component name for Login Window Submit Button To be used when the String name of the component is needed.
`static java.lang.String`	`LoginUserID` "LoginUserID" App Map component name for Login Window UserID EditBox.
`static java.lang.String`	`LoginWindow` "LoginWindow" App Map window name for Login Window.
`static Window`	`LoginWindowUI` Optional `Window` reference to our Login Window To be used when a `Component` reference might be desired instead of a String name.
`static java.lang.String`	`MAIN_MAP` "main_map"
`static java.lang.String`	`MainWindow` "MainWindow" App Map window name for main application window (after successful Login) To be used when the String name of the window is needed.
`static Window`	`MainWindowUI` Optional `Window` reference to our Main Window.

Constructor Summary

Constructors
Constructor and Description

EmbeddedJSAFSDriver()

Constructors
Constructor and Description
`EmbeddedJSAFSDriver()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type Method and Description

static void main(java.lang.String[] args)
Possible main entry point for the test class.
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`main(java.lang.String[] args)` Possible main entry point for the test class.

- Field Detail
  - MAIN_MAP
```
public static final java.lang.String MAIN_MAP
```
    "main_map"
    In our example, this should be another -D System Property passed in at invocation.
    Example:
    -Dmain_map="MyMainApp.map"
    This tells the test which primary (non-localizable) App Map should be used for the test.
    
    See Also:
    
    Constant Field Values
  - LOCAL_MAP
```
public static final java.lang.String LOCAL_MAP
```
    "local_map"
    In our example, this should be another -D System Property passed in at invocation.
    Example:
    -Dlocal_map="MyMainApp_en.map" or
    -Dlocal_map="MyMainApp_zh_CN.map"
    This tells the test which localized resource should be used for the test.
    
    See Also:
    
    Constant Field Values
  - LoginWindow
```
public static final java.lang.String LoginWindow
```
    "LoginWindow" App Map window name for Login Window. To be used when the String name of the window is needed.
    
    See Also:
    
    Constant Field Values
  - LoginUserID
```
public static final java.lang.String LoginUserID
```
    "LoginUserID" App Map component name for Login Window UserID EditBox. To be used when the String name of the component is needed.
    
    See Also:
    
    Constant Field Values
  - LoginPassword
```
public static final java.lang.String LoginPassword
```
    "LoginPassword" App Map component name for Login Window Password EditBox To be used when the String name of the component is needed.
    
    See Also:
    
    Constant Field Values
  - LoginSubmit
```
public static final java.lang.String LoginSubmit
```
    "LoginSubmit" App Map component name for Login Window Submit Button To be used when the String name of the component is needed.
    
    See Also:
    
    Constant Field Values
  - MainWindow
```
public static final java.lang.String MainWindow
```
    "MainWindow" App Map window name for main application window (after successful Login) To be used when the String name of the window is needed.
    
    See Also:
    
    Constant Field Values
  - LoginWindowUI
```
public static final Window LoginWindowUI
```
    Optional Window reference to our Login Window To be used when a Component reference might be desired instead of a String name.
  - Login_UserID
```
public static final EditBox Login_UserID
```
    Optional EditBox reference to our Login UserID field To be used when a Component reference might be desired instead of a String name.
  - Login_Password
```
public static final EditBox Login_Password
```
    Optional EditBox reference to our Login Password field To be used when a Component reference might be desired instead of a String name.
  - Login_Submit
```
public static final PushButton Login_Submit
```
    Optional PushButton reference to our Login Submit button To be used when a Component reference might be desired instead of a String name.
  - MainWindowUI
```
public static final Window MainWindowUI
```
    Optional Window reference to our Main Window. To be used when a Component reference might be desired instead of a String name.
  - jsafs
```
public JSAFSDriver jsafs
```
    A readily accessible reference to the instantiated JSAFSDriver used by the test. new JSAFSDriver("Driver");
- Constructor Detail
  - EmbeddedJSAFSDriver
```
public EmbeddedJSAFSDriver()
```
- Method Detail
  - main
```
public static void main(java.lang.String[] args)
```
    Possible main entry point for the test class. The JVM should be instanced with required -D Property settings used by this example:
    java -Dsafs.project.config="pathTo\Driver.INI" -Dmain_map="MyMainApp.map" -Dlocal_map="MyLocalApp_en.map" EmbeddedJSAFSDriver
    This example performs the following:
    Parameters:
    
    args -

Class EmbeddedJSAFSDriver

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAIN_MAP

LOCAL_MAP

LoginWindow

LoginUserID

LoginPassword

LoginSubmit

MainWindow

LoginWindowUI

Login_UserID

Login_Password

Login_Submit

MainWindowUI

jsafs

Constructor Detail

EmbeddedJSAFSDriver

Method Detail

main