org.safs.tools.drivers
Class STAFProcessContainer

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      org.safs.tools.drivers.STAFProcessContainer

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.lang.Runnable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.DocumentListener, javax.swing.event.ListSelectionListener, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class STAFProcessContainer
extends javax.swing.JFrame
implements java.awt.event.ActionListener, javax.swing.event.DocumentListener, javax.swing.event.ListSelectionListener, java.lang.Runnable

Provides similar functionality as the RRAFS ProcessContainer app in a SAFS tool-independent and multiplatform environment.

Client Type (ComboBox)
The type of client (HTML, Java, .NET, etc..) intended to be processed.

Window Recognition Method (TextField)
The recognition string identifying the topmost Window to process.

Object Recognition Method (TextField)
The recognition string identifying a particular object within the Window to process. To process all components in the Window this recognition string must be the same as the Window Recognition Method.

Process Children (CheckBox)
Process the full hierarchy of children of the object to be processed. This can be time consuming on complex containers. If not selected we will not delve into processing the children.

Window/Object Name (TextField)
The name to give the object to be processed. This is primarily for App Map and other forms of output that attempt to provide friendly names for objects.

Short Strings (CheckBox)
Shorten recognition strings. Do not include each and every layer of the object hierarchy in the recognition strings generated for App Maps.

Short Names (CheckBox)
When an object is identifiable by Name output very short recognition strings. This is because objects with unique names are safely identified wherever they are in the hierarchy.

Ignore Invisible (CheckBox)
Do not process invisible containers--containers often hidden or overlayed other containers. For example, a TabControl with 5 Tabs typically has 5 panels, but only one panel is usually visible at a time. By ignoring the hidden panels we usually get more accurate recognition strings (indices) for those that are visible.

Process Properties (CheckBox)
Capture and output the list of all available properties on each object that is processed. This can be VERY VERY time consuming, so enable this only when you really want it.

Process Menu (CheckBox)(Disabled Future Feature)
Attempt to locate and process a main menu for the Window to be processed. This historically only applied to native OS applications (Windows). Processing involves identifying all menus, menuitems, their properties and state information.

Menu Name (TextField)(Disabled Future Feature)
A name to give the menu to be processed.

Object Description (TextField)
A short description of the object being processed.

Output Directory (TextField)
The directory where output files should be written.

Output Filename Prefix (TextField)
The root name to give the object and menu output files. The tool will append "Obj.txt" and "Menu.txt" to this root to form the complete filenames for output.

Output Filenames (Labels)
Display of the filenames that will be output based on the Output Directory and Output Filename Prefix provided.

Append App Map (CheckBox)
If selected we will append all App Map output to the file specified in App Map File. Skips generating App Map output if this is not selected.

App Map File (TextField)
The full path filename to a text-based App Map. The App Map will be created if it does not already exist. It will be appended if it does. Nothing happens if Append App Map is not selected.

Add Component Info (CheckBox)
Component "Type" information will be appended to each object recognition string output. This is useful when using the App Map output to import component information into other tools. However, this information is not compatible with normal App Map usage (during testing) because the recognition string is no longer properly formed.

Map JPG (CheckBox)(Disabled Future Feature)
Attempts to screenshot the window being processed and provide special HTML output allowing the user to interactively examine the snapshot for component information. This can be a time consuming process just like Process Properties.

Run (Button)
Click to begin processing object(s).

Cancel (Button)
Cancels any object processing that may be in progress.

Help (Button)
Displays this document.

While this class is a JFrame, it wraps a STAFProcessContainerDriver and requires Driver configuration information (INI file) just like the SAFSDRIVER (TID)

The ProcessContainer.INI file for this tool can contain configuration information for both the SAFS Driver and the Process Container functionality. A bare minimum configuration would identify the location of the SAFS Project in which additional configuration information might be provided in SAFSTID.INI files:

 [SAFS_PROJECT]
 ProjectRoot="c:\SAFSProject"
 

More likely the user will want to identify SAFS Engines to use\launch for Process Container to interact with:

 [SAFS_PROJECT]
 ProjectRoot="c:\SAFSProject"
 
 [SAFS_ENGINES]
 First=org.safs.tools.engines.SAFSROBOTJ
 
 [SAFS_ROBOTJ]
 AUTOLAUNCH=TRUE
 PLAYBACK=TestScript
 DATASTORE=C:\RFTDatastore
 INSTALLDIR="C:\Program Files\IBM\Rational\SDP\6.1\FunctionalTester\eclipse\plugins\com.rational.test.ft.wswplugin_6.1.0"
 

With information like this the STAFProcessContainer can be successfully launched and used with a command line like:

 java -Dsafs.processcontainer.ini=c:\SAFSProject\ProcessContainer.ini org.safs.tools.drivers.STAFProcessContainer
 

args -- command-line args to main(). These can be overridden by System property setting using -Dsetting on the command-line. Consult the doc for each individual args setting in the Field and Method details of this document.

Generally, the System property arg is in the format

-Dsafs.processcontainer.[argname]

as in:

-Dsafs.processcontainer.ini=<path to INI initialization file>

• "ini=<path to INI initialization file>"
• "map=<path to MAP output file>"
• "out=<path to detailed output file>"
• "menu=<path to menu output file>"
• "client=Java Client"
• "windowRec=Type=Window;Caption={*}"
• "objectRec=\;Type=Window;Caption={*}"
• "objectName=<objectname>"
• "objectDesc=<object description>"
• "outputviewer=<file viewer/editor>"
• "fullpathSearch=true"
• "doChildren=true"
• "doProperties=false"
• "doMenu=false"
• "menuName=<menuname>"
• "outDir=<path to output directory>"
• "outPrefix=<objectname>"
• "appendMap=false"
• "addInfo=false"
• "mapJPG=false"
• "ignoreInvisible=true"
• "shortRecognition=false"
• "shortWithName=false"
• "ignoreChildrenInListTableCombobox=true"
• "delayToRun=4"
• "rsStrategy.qualifier=true"
• "rsStrategy.useName=true"
• "rsStrategy.useid=false"
• "rsStrategy.useGenericType=false"

See Also:

Serialized Form

Nested Class Summary

class	STAFProcessContainer.HierarchyDlg HierarchyDlg derived from JFrame, with a JTree inside, is able to show the hierarchy of the PCTree passed in.
class	STAFProcessContainer.Processor Process a component.
class	STAFProcessContainer.RsPCTreeMap
class	STAFProcessContainer.RunThread
class	STAFProcessContainer.ShutdownListener
protected class	STAFProcessContainer.ValidatingEditor This class override the method stopCellEditing() of DefaultCellEditor. User needs to set a ValidatingListener to this class so that it can decide if the modification of the editor will be accepted or not.
class	STAFProcessContainer.ValidatingEventObject
static interface	STAFProcessContainer.ValidatingListener

Nested classes/interfaces inherited from class javax.swing.JFrame

javax.swing.JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

java.awt.Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected static java.lang.String[]	args Passed in from static void main()
static boolean	DEFAULT_ADDINFO 'false'
static boolean	DEFAULT_APPENDMAP 'false'
static java.lang.String	DEFAULT_CLIENT_DISPLAY JAVA_CLIENT_DISPLAY
static java.lang.String	DEFAULT_CLIENT_TEXT JAVA_CLIENT_TEXT
static java.lang.String	DEFAULT_DELAY_TO_RUN
static boolean	DEFAULT_DOCHILDREN 'true'
static boolean	DEFAULT_DOMENU 'false'
static boolean	DEFAULT_DOPROPERTIES 'false'
static java.lang.String	DEFAULT_INI_SECTION null
static boolean	DEFAULT_MAPJPG 'false'
static java.lang.String	DEFAULT_MENUNAME "WindowNameMenu"
static java.lang.String	DEFAULT_OBJECTDESC "WindowName Object"
static java.lang.String	DEFAULT_OBJECTNAME "WindowName"
static java.lang.String	DEFAULT_OBJECTREC "CurrentWindow"
static java.lang.String	DEFAULT_WINDOWREC "CurrentWindow"
static java.lang.String	DELAYING_TEXT
protected java.lang.String	inipath Provided path to initialization file.
static java.lang.String	line_separator
protected java.lang.String	mappath Provided path to app map output file.
protected java.lang.String	menupath Provided path to menu output file.
protected java.lang.String	outpath Provided path to detailed output file.
static java.lang.String	OUTPUT_VIEWER_KEY
static java.lang.String	pathSep "->"
static java.lang.String	READY_TEXT "Click to Run"
static java.lang.String	RUNNING_TEXT "Running..."
static java.lang.String	STAF_PROCESS_CONTAINER_PROCESS "STAFProcessContainer"
static java.lang.String	STAF_PROCESS_CONTAINER_TITLE "STAF Process Container"
protected boolean	theAddInfo Provided addInfo.
protected boolean	theAppendMap Provided appendMap.
protected java.lang.String	theClientType Provided clientType.
protected java.lang.String	theDelayToRun Time to delay before SPC starts to search.
protected boolean	theDoChildren Provided doChildren.
protected boolean	theDoMenu Provided doMenu.
protected boolean	theDoProperties Provided doProperties.
protected boolean	theMapJPG Provided mapJPG.
protected java.lang.String	theMenuName Provided menuName.
protected java.lang.String	theObjectDesc Provided objectDesc.
protected java.lang.String	theObjectName Provided objectName.
protected java.lang.String	theObjectRec Provided objectRec.
protected java.lang.String	theOutDir Provided output directory.
protected java.lang.String	theOutPrefix Provided output file prefix.
protected java.lang.String	theWindowRec Provided windowRec.
static int	VISIBLE_COUNT_IN_LIST VISIBLE_COUNT_IN_LIST

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

STAFProcessContainer()
Constructor for ProcessContainer.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent event) Launches separate execution Processor when the RUN button is clicked.
void	changedUpdate(javax.swing.event.DocumentEvent event) Monitor TextField DocumentChanged Events.
protected void	closeMapPathStream() Close the Map output file if possible.
protected void	closeOutPathStream() Close the detailed output file if possible.
protected void	configureUI() Configures/Toggles UI components based on current/stored settings.
protected void	documentChanged(javax.swing.event.DocumentEvent event)
protected void	enableClickToRun()
protected void	finalize() shutdown finalization
protected java.lang.String	getArg(java.lang.String argid) Attempt to retrieve an arg String value via our specific search chain.
protected boolean	getBooleanArg(java.lang.String argid)
protected java.lang.String	getINIValue(java.lang.String section, java.lang.String item) Retrieve an item out of the initialization file if such a file was identified.
void	insertUpdate(javax.swing.event.DocumentEvent event)
boolean	isInterrupted()
boolean	isStopped()
static void	main(java.lang.String[] args) main
protected java.lang.String	makeFullPrefix(java.lang.String theDir, java.lang.String thePrefix) Add the prefix to our stored directory info adding(or not) the File.separator if needed.
protected void	openINIReadWrite() Open/Process the initialization file if it is found and appears to be valid.
protected void	openMapPathStream() Open the map output file if possible.
protected void	openOutPathStream() Open the detailed output file if possible.
protected void	populateFrame() Build the JFrame GUI for viewing.
void	removeUpdate(javax.swing.event.DocumentEvent event)
void	run() 'Runnable' Shutdown Hook registered with JVM to do finalization on exit.
void	setInterrupt(boolean _interrupted)
void	setStopped(boolean _stop)
protected void	statInfo(java.lang.String info) Display a status message.
void	valueChanged(javax.swing.event.ListSelectionEvent e)

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

STAF_PROCESS_CONTAINER_TITLE

public static final java.lang.String STAF_PROCESS_CONTAINER_TITLE

"STAF Process Container"

See Also:

Constant Field Values

STAF_PROCESS_CONTAINER_PROCESS

public static final java.lang.String STAF_PROCESS_CONTAINER_PROCESS

"STAFProcessContainer"

See Also:

Constant Field Values

DEFAULT_CLIENT_DISPLAY

public static final java.lang.String DEFAULT_CLIENT_DISPLAY

JAVA_CLIENT_DISPLAY

See Also:

Constant Field Values

DEFAULT_CLIENT_TEXT

public static final java.lang.String DEFAULT_CLIENT_TEXT

JAVA_CLIENT_TEXT

See Also:

Constant Field Values

VISIBLE_COUNT_IN_LIST

public static final int VISIBLE_COUNT_IN_LIST

VISIBLE_COUNT_IN_LIST

See Also:

Constant Field Values

line_separator

public static java.lang.String line_separator

args

protected static java.lang.String[] args

Passed in from static void main()

inipath

protected java.lang.String inipath

Provided path to initialization file. JVM Command-Line: -Dsafs.processcontainer.ini= System Property: safs.processcontainer.ini= main() ARGS Parm: ini=

mappath

protected java.lang.String mappath

Provided path to app map output file. JVM Command-Line: -Dsafs.processcontainer.map= System Property:safs.processcontainer.map= INI File Setting: map= main() ARGS Parm: map=

An ARGS Parm overrides the System Property which overrides any INI file setting.

outpath

protected java.lang.String outpath

Provided path to detailed output file. JVM Command-Line: -Dsafs.processcontainer.out= System Property:safs.processcontainer.out= INI File Setting: out= main() ARGS Parm: out=

An ARGS Parm overrides the System Property which overrides any INI file setting.

menupath

protected java.lang.String menupath

Provided path to menu output file. JVM Command-Line: -Dsafs.processcontainer.menu= System Property:safs.processcontainer.menu= INI File Setting: menu= main() ARGS Parm: menu=

An ARGS Parm overrides the System Property which overrides any INI file setting.

theClientType

protected java.lang.String theClientType

Provided clientType. Support values at this time: "Java Client" JVM Command-Line: "-Dsafs.processcontainer.client=Java Client" System Property:safs.processcontainer.client="Java Client" INI File Setting: client="Java Client" main() ARGS Parm: "client=Java Client"

An ARGS Parm overrides the System Property which overrides any INI file setting.

DEFAULT_WINDOWREC

public static final java.lang.String DEFAULT_WINDOWREC

"CurrentWindow"

See Also:

Constant Field Values

theWindowRec

protected java.lang.String theWindowRec

Provided windowRec. Defaults to CurrentWindow JVM Command-Line: "-Dsafs.processcontainer.windowRec=CurrentWindow" System Property:safs.processcontainer.windowRec="CurrentWindow" INI File Setting: windowRec="CurrentWindow" main() ARGS Parm: windowRec="CurrentWindow"

An ARGS Parm overrides the System Property which overrides any INI file setting.

DEFAULT_OBJECTREC

public static final java.lang.String DEFAULT_OBJECTREC

"CurrentWindow"

See Also:

Constant Field Values

theObjectRec

protected java.lang.String theObjectRec

Provided objectRec. Defaults to CurrentWindow JVM Command-Line: "-Dsafs.processcontainer.objectRec=CurrentWindow" System Property:safs.processcontainer.objectRec="CurrentWindow" INI File Setting: objectRec="CurrentWindow" main() ARGS Parm: objectRec="CurrentWindow"

An ARGS Parm overrides the System Property which overrides any INI file setting.

DEFAULT_OBJECTNAME

public static final java.lang.String DEFAULT_OBJECTNAME

"WindowName"

See Also:

Constant Field Values

theObjectName

protected java.lang.String theObjectName

Provided objectName. Defaults to WindowName JVM Command-Line: "-Dsafs.processcontainer.objectName=WindowName" System Property:safs.processcontainer.objectName="WindowName" INI File Setting: objectName="WindowName" main() ARGS Parm: "objectName=WindowName"

An ARGS Parm overrides the System Property which overrides any INI file setting.

DEFAULT_OBJECTDESC

public static final java.lang.String DEFAULT_OBJECTDESC

"WindowName Object"

See Also:

Constant Field Values

theObjectDesc

protected java.lang.String theObjectDesc

Provided objectDesc. Defaults to WindowName Object JVM Command-Line: "-Dsafs.processcontainer.objectDesc=WindowName Object" System Property:safs.processcontainer.objectDesc="WindowName Object" INI File Setting: objectDesc="WindowName Object" main() ARGS Parm: "objectDesc=WindowName Object"

An ARGS Parm overrides the System Property which overrides any INI file setting.

DEFAULT_DOCHILDREN

public static final boolean DEFAULT_DOCHILDREN

'true'

See Also:

Constant Field Values

theDoChildren

protected boolean theDoChildren

Provided doChildren. Defaults to true. JVM Command-Line: "-Dsafs.processcontainer.doChildren=true" System Property:safs.processcontainer.doChildren="true" INI File Setting: doChildren="true" main() ARGS Parm: "doChildren=true"

An ARGS Parm overrides the System Property which overrides any INI file setting.

DEFAULT_DOPROPERTIES

public static final boolean DEFAULT_DOPROPERTIES

'false'

See Also:

Constant Field Values

theDoProperties

protected boolean theDoProperties

Provided doProperties. Defaults to false. JVM Command-Line: "-Dsafs.processcontainer.doProperties=true" System Property:safs.processcontainer.doProperties="true" INI File Setting: doProperties="true" main() ARGS Parm: "doProperties=true"

An ARGS Parm overrides the System Property which overrides any INI file setting.

DEFAULT_DOMENU

public static final boolean DEFAULT_DOMENU

'false'

See Also:

Constant Field Values

theDoMenu

protected boolean theDoMenu

Provided doMenu. Defaults to false. JVM Command-Line: "-Dsafs.processcontainer.doMenu=true" System Property:safs.processcontainer.doMenu="true" INI File Setting: doMenu="true" main() ARGS Parm: "doMenu=true"

An ARGS Parm overrides the System Property which overrides any INI file setting.

DEFAULT_MENUNAME

public static final java.lang.String DEFAULT_MENUNAME

"WindowNameMenu"

See Also:

Constant Field Values

theMenuName

protected java.lang.String theMenuName

Provided menuName. Defaults to WindowNameMenu JVM Command-Line: "-Dsafs.processcontainer.menuName=WindowNameMenu" System Property:safs.processcontainer.menuName="WindowNameMenu" INI File Setting: menuName="WindowNameMenu" main() ARGS Parm: "menuName=WindowNameMenu"

An ARGS Parm overrides the System Property which overrides any INI file setting.

theOutDir

protected java.lang.String theOutDir

Provided output directory. Defaults to user current directory. JVM Command-Line: "-Dsafs.processcontainer.outDir=<current directory>" System Property:safs.processcontainer.outDir="<current directory>" INI File Setting: outDir="<current directory>" main() ARGS Parm: "outDir=<current directory>"

An ARGS Parm overrides the System Property which overrides any INI file setting.

theOutPrefix

protected java.lang.String theOutPrefix

Provided output file prefix. Defaults to WindowName. JVM Command-Line: "-Dsafs.processcontainer.outPrefix=WindowName" System Property:safs.processcontainer.outPrefix="WindowName" INI File Setting: outPrefix="WindowName" main() ARGS Parm: "outPrefix=WindowName"

An ARGS Parm overrides the System Property which overrides any INI file setting.

DEFAULT_APPENDMAP

public static final boolean DEFAULT_APPENDMAP

'false'

See Also:

Constant Field Values

theAppendMap

protected boolean theAppendMap

Provided appendMap. Defaults to false. JVM Command-Line: "-Dsafs.processcontainer.appendMap=false" System Property:safs.processcontainer.appendMap="false" INI File Setting: appendMap="false" main() ARGS Parm: "appendMap=false"

An ARGS Parm overrides the System Property which overrides any INI file setting.

DEFAULT_ADDINFO

public static final boolean DEFAULT_ADDINFO

'false'

See Also:

Constant Field Values

theAddInfo

protected boolean theAddInfo

Provided addInfo. Defaults to false. JVM Command-Line: "-Dsafs.processcontainer.addInfo=false" System Property:safs.processcontainer.addInfo="false" INI File Setting: addInfo="false" main() ARGS Parm: "addInfo=false"

An ARGS Parm overrides the System Property which overrides any INI file setting.

DEFAULT_MAPJPG

public static final boolean DEFAULT_MAPJPG

'false'

See Also:

Constant Field Values

theMapJPG

protected boolean theMapJPG

Provided mapJPG. Defaults to false. JVM Command-Line: "-Dsafs.processcontainer.mapJPG=false" System Property:safs.processcontainer.mapJPG="false" INI File Setting: mapJPG="false" main() ARGS Parm: "mapJPG=false"

An ARGS Parm overrides the System Property which overrides any INI file setting.

DEFAULT_DELAY_TO_RUN

public static final java.lang.String DEFAULT_DELAY_TO_RUN

See Also:

Constant Field Values

theDelayToRun

protected java.lang.String theDelayToRun

Time to delay before SPC starts to search. Defaults to 2. JVM Command-Line: "-Dsafs.processcontainer.delayToRun=2" System Property:safs.processcontainer.delayToRun="2" INI File Setting: delayToRun="2" main() ARGS Parm: "delayToRun=2"

An ARGS Parm overrides the System Property which overrides any INI file setting.

DEFAULT_INI_SECTION

public static final java.lang.String DEFAULT_INI_SECTION

null

pathSep

public static final java.lang.String pathSep

"->"

See Also:

Constant Field Values

OUTPUT_VIEWER_KEY

public static final java.lang.String OUTPUT_VIEWER_KEY

See Also:

Constant Field Values

READY_TEXT

public static final java.lang.String READY_TEXT

"Click to Run"

See Also:

Constant Field Values

RUNNING_TEXT

public static final java.lang.String RUNNING_TEXT

"Running..."

See Also:

Constant Field Values

DELAYING_TEXT

public static final java.lang.String DELAYING_TEXT

See Also:

Constant Field Values

Constructor Detail

STAFProcessContainer

public STAFProcessContainer()

Constructor for ProcessContainer.

Method Detail

setInterrupt

public void setInterrupt(boolean _interrupted)

isInterrupted

public boolean isInterrupted()

setStopped

public void setStopped(boolean _stop)

isStopped

public boolean isStopped()

openOutPathStream

protected void openOutPathStream()

Open the detailed output file if possible. Otherwise we keep the System.out default.

closeOutPathStream

protected void closeOutPathStream()

Close the detailed output file if possible. Otherwise we keep the System.out default.

openMapPathStream

protected void openMapPathStream()

Open the map output file if possible. Otherwise we keep the System.out default.

closeMapPathStream

protected void closeMapPathStream()

Close the Map output file if possible. Otherwise we keep the System.out default.

openINIReadWrite

protected void openINIReadWrite()

Open/Process the initialization file if it is found and appears to be valid.

getINIValue

protected java.lang.String getINIValue(java.lang.String section,
                                       java.lang.String item)

Retrieve an item out of the initialization file if such a file was identified.

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent event)

Monitor TextField DocumentChanged Events.

Specified by:

changedUpdate in interface javax.swing.event.DocumentListener

insertUpdate

public void insertUpdate(javax.swing.event.DocumentEvent event)

Specified by:

insertUpdate in interface javax.swing.event.DocumentListener

removeUpdate

public void removeUpdate(javax.swing.event.DocumentEvent event)

Specified by:

removeUpdate in interface javax.swing.event.DocumentListener

documentChanged

protected void documentChanged(javax.swing.event.DocumentEvent event)

configureUI

protected void configureUI()

Configures/Toggles UI components based on current/stored settings.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Launches separate execution Processor when the RUN button is clicked. This will process all known top-level Windows.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

populateFrame

protected void populateFrame()

Build the JFrame GUI for viewing.

statInfo

protected void statInfo(java.lang.String info)

Display a status message. This message is also forwarded to Log.info

Parameters:

info - status String to display and log to Log.info

makeFullPrefix

protected java.lang.String makeFullPrefix(java.lang.String theDir,
                                          java.lang.String thePrefix)

Add the prefix to our stored directory info adding(or not) the File.separator if needed.

finalize

protected void finalize()
                 throws java.lang.Throwable

shutdown finalization

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

getArg

protected java.lang.String getArg(java.lang.String argid)

Attempt to retrieve an arg String value via our specific search chain. First try the command-line args directly for a match.

arg=value

If not found there try the the appropriate System property that would have been set on the command-line..

-Dsafs.processcontainer.arg=value

If not found there try looking for a stored value in the INI file.

Returns:

String value of the arg or null if the value was not found.

getBooleanArg

protected boolean getBooleanArg(java.lang.String argid)

Returns:

true if arg String value equals ignoring case to "true". Any other String value will result in a return of false.

run

public void run()

'Runnable' Shutdown Hook registered with JVM to do finalization on exit. Users MUST NOT call this as it will execute the Object's finalize() method.

Specified by:

run in interface java.lang.Runnable

enableClickToRun

protected void enableClickToRun()

main

public static void main(java.lang.String[] args)

main

valueChanged

public void valueChanged(javax.swing.event.ListSelectionEvent e)

Specified by:

valueChanged in interface javax.swing.event.ListSelectionListener