com.jFormTK
Class JHDD_IO

java.lang.Object
  extended by com.jFormTK.JHDD_IO
All Implemented Interfaces:
JConstants

public abstract class JHDD_IO
extends java.lang.Object
implements JConstants

This jFormTK Abstract Class is designed to hold the jFormTK Hard Drive Device [HDD] input / output Methods... All 'jFormTK' Kernel read / write to HDD operations are performed via methods of this class...

Version:
1.00, 15 July 1998
Author:
Jim Crowell
Professional Computer Solutions [PCS]
URL: http://jFormTK.com/
E-Mail: JimCrowell@EMail.com

Copyright (c) 2009 by Professional Computer Solutions [PCS]
All Rights Reserved

Nested Class Summary
(package private)  class JHDD_IO.IODialog
           
 class JHDD_IO.JHideFrame
           
 
Field Summary
(package private) static java.lang.String[] activeWorkSheetFields
           
(package private) static java.lang.String[] activeWorkSheetType
           
(package private) static java.lang.String blankLine
           
(package private) static char C_QUOTE
           
(package private) static int fieldsLength
           
(package private) static int GROUP_ALIGN
           
(package private) static info.clearthought.layout.TableLayout groupPanelLayout
           
(package private) static java.lang.String horizontalLine
           
(package private) static java.lang.String imageName
           
static int lastImageType
           
(package private) static info.clearthought.layout.TableLayout layout
           
(package private) static java.util.Vector references
           
(package private) static java.lang.String SEMICOLON
           
(package private) static JFormFrame.JShowPanel showPanel
           
(package private) static java.lang.String[] stringConstantKEYs
           
(package private) static java.lang.String[] systemDelimiters
           
(package private) static int[] vLineMode
           
 
Fields inherited from interface com.jFormTK.JConstants
__, _AB, _AB_, _AField, _B, _BField, _CField, _CIField, _DField, _EU_, _H, _HEIGHT, _HEIGHT_INV, _HField, _I, _IField, _LField, _MField, _NField, _NotRequired, _PField, _PIField, _QField, _Required, _RField, _TAField, _TField, _WIDTH, _WIDTH_INV, _XField, AB, APP_TRACE_FOCUS, APP_TRACE_GET, APP_TRACE_SET, B_, BAR, BAR_, BB, BH, BI, BREAKPOINT_FOCUS, BREAKPOINT_GET, BREAKPOINT_SET, BVB, CLOSE, CLOSE_BRACKET, COLORS_DELIMITER, COMMA, COMMA_, D_ELEMENT, D_ELEMENT_N, D_ELEMENT_N1, D_ELEMENT_N2, D_ELEMENT_N3, D_FIELDS, D_FIELDS_N, D_FIELDS_N1, D_FIELDS_N2, D_FIELDS_N3, D_ITEMS, DASH, DOT, EOL, EOP, EOS, FIELD_TRACE_FOCUS, FIELD_TRACE_GET, FIELD_TRACE_SET, FONT_DELIMITER, H_, HB, HH, HI, I_, IB, IH, II, JLAF_DELIMITER, LF, LISTBRACKET, NO, OPEN, OPEN_BRACKET, pCheckboxGroup, QUOTE, SPACE_, TAB, YES
 
Constructor Summary
JHDD_IO()
           
 
Method Summary
static void changeLoadState(JFormForm form, char toLoadState, java.lang.String from)
           Change the given 'JFormForm' load State as a function of the given Load Status Control [loadState]...
static int definition(JFormForm form, int lineMode, java.lang.String definition, java.lang.String inName, int row, java.awt.Color background, java.awt.Color foreground, java.awt.Font font, java.lang.String hintText)
           This 'JHDD_IO' Utility is designed to create a Label Field [_LField] 'JFormField' and insert it into the current ShowPanel...
static int definition(JFormForm form, int lineMode, java.lang.String definition, java.lang.String inName, int row, java.awt.Font font, java.lang.String hint)
           This 'JHDD_IO' Utility is designed to create a Label Field [_LField] 'JFormField' and insert it into the current ShowPanel...
static int definition(JFormForm form, int lineMode, java.lang.String definition, java.lang.String inName, int row, java.lang.String hint)
           This 'JHDD_IO' Utility is designed to create a Label Field [_LField] 'JFormField' and insert it into the current ShowPanel...
static void exitApplication(JFormForm form)
           
static java.lang.String filesDisplay(java.lang.String path, java.lang.String extensionIn)
           This method is designed to produce a Display String of the files in the given path with the specified extension...
static boolean filesExist(java.lang.String path, java.lang.String extensionIn)
           This method is designed to search the given directory for Files with the given Extension.
static java.lang.String getAbsolutePath(java.lang.String inPath, java.lang.String category, java.lang.String fileName, java.lang.String extension)
           This method is designed to return the 'absolutePath' String for the File Specified by the given File Parameters,e.g.
static JarResources getAppImagesJAR(java.lang.String from)
           Return the 'JarResources' instance for the Application Images JAR...
static long getFileDate(java.lang.String inPath, java.lang.String category, java.lang.String fileName, java.lang.String extension)
           Return a long Integer that contains the 'lastModified' Date for the File Specified by the given File Parameters, e.g.
static java.io.File[] getFolderFiles(java.lang.String folderPath)
           Return an Array of File instances = f[folderPath] parameter...
static java.io.File[] getFolderFiles(java.lang.String folderPath, java.lang.String annotation, boolean debug)
           
static java.lang.String getFormsFilePath(JFormForm form)
           Create a "Forms File Path" String given a 'JFormForm' instance.
static java.lang.String getFormsFilePath(java.lang.String category, java.lang.String fileName)
           Create a "Forms File Path" String given a the Category, and Form File Name parameters.
static javax.swing.ImageIcon getIcon(java.lang.String fileName, java.lang.String from)
           Return an ImageIcon as a function of the the given File Name parameter [fileName].
static java.awt.Image getImage(java.lang.String fileNameIn, java.lang.String from)
           Return an 'Image' as a function of the the given File Name parameter [fileName]...
static java.io.File[] getImageFiles(java.lang.String folderPath, java.lang.String annotation, boolean debug)
           Return an Array of File instances = f[folderPath] parameter...
static JarResources getJFormTKImagesJAR(java.lang.String from)
           Return the 'JarResources' instance for the 'jFormTK' Kernel Images JAR...
static java.lang.String getSystemProp()
           Create a Java String that displays the System Properties, one pre line, of the current execution host platform...
static void insertBlankLine(JFormForm form, java.lang.String name, java.awt.Color background, int row)
           Insert a blank line into the given 'JFormForm' [form] at the specified Row.
static void insertBlankLine(JFormForm form, java.lang.String name, int row)
           Insert a blank line into the given 'JFormForm' [form] at the specified Row.
static void insertHorizontalRule(JFormForm form, java.lang.String name, int row)
           Insert a Horizontal Rule into the given 'JFormForm' [form] at the specified Row.
static boolean isFile(java.lang.String path)
           If there is a file for the current 'JFormForm' on the storage device, then the return flag is set to true.
static boolean isFile(java.lang.String category, java.lang.String fileName)
           If there is a file for the current 'JFormForm' on the storage device, then the return flag is set to true.
static boolean isFile(java.lang.String inPath, java.lang.String category, java.lang.String fileName, java.lang.String extension)
           Determine if there exist a File for the given File Paremeters...
static void nextField()
           
static int query(JFormForm form, int lineMode, java.lang.String prompt, java.lang.String inName, int row, java.awt.Color background, java.awt.Color foreground, java.awt.Font font, java.lang.String hint)
           Produce a '_LField' and a '_BField' [and an optional 'Space'] 'JFormField' to present a Query to the Application End User with a 'YES' Action Button Option...
static int query(JFormForm form, int lineMode, java.lang.String prompt, java.lang.String inName, int row, java.awt.Color background, java.awt.Color foreground, java.awt.Font font, java.lang.String hint, java.awt.Color bBackground, java.awt.Color bForeground, java.awt.Font bFont)
           Produce a '_LField' and a '_BField' [and an optional 'Space'] 'JFormField' to present a Query to the Application End User with a 'YES' Action Button Option...
static int query(JFormForm form, int lineMode, java.lang.String prompt, java.lang.String inName, int row, java.awt.Font font, java.lang.String hint)
           Produce a '_LField' and a '_BField' [and an optional 'Space'] 'JFormField' to present a Query to the Application End User with a 'YES' Action Button Option...
static int query(JFormForm form, int lineMode, java.lang.String prompt, java.lang.String inName, int row, java.lang.String hint)
           Produce a '_LField' and a '_BField' [and an optional 'Space'] 'JFormField' to present a Query to the Application End User with a 'YES' Action Button Option...
static java.util.Vector readBreakpointLOG()
           Read the Breakpoint LOG file from the Application's Root Directory...
static java.lang.String[] readFileControls(java.lang.String category, java.lang.String fileName)
           Read the "Saved" Strings for the File Controls, i.e.
static boolean readFormFields(JFormForm form, java.lang.String from)
           Read the "savedJFormField" Strings for each 'JFormField' of the given 'JFormForm', transform each to a 'JFormField' of the 'formFields' Vector...
static int readJAddressBook(JAddressBook aBook)
           This 'jFormTK.JHDD_IO' Method is designed to load the current 'JAddressBook' from the Application Designated Hard Drive Devise [HDD].
static java.lang.Object readObject(java.lang.String fileName)
           This method is designed to read an 'Object' from the File Name specified [fileName] at the Application Root Directory...
static java.lang.String[] readTextFile(java.lang.String path)
           read a Text File from the HDD given an Absolute File path...
static java.lang.String readTextFileIntoString(java.lang.String path)
           Read a Text File from the HDD given an Absolute File path into a return String with the 'JConstants.LF' inserted after each line...
static void redrawPage(JFormForm form, JFormField fld)
           This metod is designed to redraw the specific 'FormForm' with the cursor located at the specified 'JFormField'.
static void removeDefinition(JFormForm form, java.lang.String definitionName)
           Remove the definition JFormField's from the given 'JFormForm' form.
static void removeQuery(JFormForm form, java.lang.String queryName)
           Remove the query JFormField's from the given 'JFormForm' form.
static void revert(JFormForm form)
           Set the current 'JFormForm' file to the 'revert' File and set the 'revert' File to the current File, i.e.
static void setJarResources(java.lang.String appFolder)
           Build the 'JarResources' object for the Application Images Jar file [e.g.
static void showFiles(java.lang.String path, java.lang.String extension)
           Produce a message Dialog listing of the files in the given path with the specified extension...
static void showPage(JFormForm form, JFormField focusFld, java.lang.String from)
           This method is designed to show the given 'JFormForm' SubClass in the 'jFormTK' Show Panel [form] and to set the 'JFormField' Focus on the specified field [targetFieldIn]...
static void showSystemProp()
           Create a Dialog Window that displays the System Properties...
static void writeBreakpointLOG(java.util.Vector log)
           Write the Breakpoint LOG file to the Application's Root Directory...
static boolean writeJAddressBook()
           Write the Application Data base [AppDB] Address Book to the HDD...
static boolean writeJAddressBook(JAddressBook aBook)
           Write the given 'JAddressBook' to the Form Device...
static boolean writeObject(java.lang.Object object, java.lang.String fileName)
           Write the given Object [object] to the specified HDD FileName...
static int writeToForm(JFormForm form, java.lang.String from)
           Write the given JFormForm and it's 'JFormInfo' / 'JFormState' Fields to the storage device.
static boolean writeWorkSheet(JWorkSheet ws, JFormForm form)
           Write the given Work Sheet File to the HDD...
static boolean writeWorkSheet(JWorkSheet ws, java.lang.String category, java.lang.String fileName)
           Write the given Work Sheet File to the HDD...
static boolean writeWorkSheet(JWorkSheet ws, java.lang.String workSheetRoot, java.lang.String category, java.lang.String fileName)
           Write the given Work Sheet File to the HDD...
static int XXXgetLastImageType()
           Return the current 'lastImageType' int...
static JWorkSheet XXXreadWorkSheet(JFormForm form)
           Read the 'JWorkSheet' File of the WorkSheets' Application Folder that is associazated with the given 'JFormForm' SubClass instance...
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

lastImageType

public static int lastImageType

activeWorkSheetFields

static final java.lang.String[] activeWorkSheetFields

activeWorkSheetType

static java.lang.String[] activeWorkSheetType

blankLine

static java.lang.String blankLine

C_QUOTE

static char C_QUOTE

fieldsLength

static int fieldsLength

GROUP_ALIGN

static int GROUP_ALIGN

groupPanelLayout

static info.clearthought.layout.TableLayout groupPanelLayout

horizontalLine

static java.lang.String horizontalLine

imageName

static java.lang.String imageName

layout

static info.clearthought.layout.TableLayout layout

references

static java.util.Vector references

SEMICOLON

static java.lang.String SEMICOLON

showPanel

static JFormFrame.JShowPanel showPanel

stringConstantKEYs

static java.lang.String[] stringConstantKEYs

systemDelimiters

static java.lang.String[] systemDelimiters

vLineMode

static int[] vLineMode
Constructor Detail

JHDD_IO

public JHDD_IO()
Method Detail

changeLoadState

public static void changeLoadState(JFormForm form,
                                   char toLoadState,
                                   java.lang.String from)
        Change the given 'JFormForm' load State as a function of the given Load Status 
        Control [loadState]...
 
        NOTE: 
        This method actually changes the 'JFormForm' Vectors as a function of the given 
        Load State [loadState]...
        When there is a request to "Save" the 'JFormForm' Data but to stay in the 
        "Display Fields State" State, this method is NOT used.
        Rather, a temporary 'jFormFields' Vector is constructed for usage by the 
        'WriteForm' Method...
        Kernel Usage:
        1)      'JFormFrame.verifyForm' method to ensure the requested form is loaded...
 

Parameters:
form - Current 'JFormForm' Sub-Class...
toLoadState - Load State, e.g. 'A' to convert to.
from - DEBUG annotation for the calling class/method...

definition

public static int definition(JFormForm form,
                             int lineMode,
                             java.lang.String definition,
                             java.lang.String inName,
                             int row,
                             java.awt.Color background,
                             java.awt.Color foreground,
                             java.awt.Font font,
                             java.lang.String hintText)
        This 'JHDD_IO' Utility is designed to create a Label Field [_LField] 'JFormField'
        and insert it into the current ShowPanel...
 
        Usage:
        1)      Convenience method to make the creation of a "Definition" object in the 
                Show Panel. This special _LField JFormField is setup with a unique name so
                that it may be dynamically removed from the show Panel when no longer
                required...
        

Parameters:
form - Host 'JFormField' SubClass Reference...
lineMode - 'lineMode' DEFINITION: Bits to control the Pre / Post line inserts... Bit 0 - Insert Blank Pre... Bit 1 - Insert HR Pre... Bit 2 - Insert Image Pre... Bit 3 - Insert Blank Post... Bit 4 - Insert HR Post... Bit 5 - Insert Image Post... USAGES: lineMode = 00 0000 = 0x00 = __ - No Space Line Inserts... = 00 0001 = 0x01 = B_ - Insert Blank Pre ONLY... = 00 0010 = 0x02 = H_ - Insert HR Pre ONLY... = 00 0100 = 0x04 = I_ - Insert Image Pre ONLY... = 00 1000 = 0x08 = _B - Insert Blank Post ONLY... = 01 0000 = 0x10 = _H - Insert HR Post ONLY... = 10 0000 = 0X20 = _I - Insert Image Post ONLY... = 00 1001 = 0x09 = BB - Insert Blank Pre and Post... = 01 0010 = 0x12 = HH - Insert HR Pre and Post... = 10 0100 = 0x24 = II - Insert Image Pre and Post... = 01 0001 = 0x11 = BH - Insert Blank Pre and HR Post... = 10 0001 = 0x21 = BI - Insert Blank Pre and Image Post... = 00 1010 = ox0A = HB - Insert HR Pre and Blank Post... = 10 0010 = ox22 = HI - Insert HR Pre and Image Post... = 00 1100 = ox0C = IB - Insert Image Pre and Blank Post... = 01 0100 = ox14 = IH - Insert Image Pre and HR Post...
definition - Label String...
inName - Definition _LField Field Name [String]...
row - Insert Row Number [int]...
background - Background Color for the Definition 'JFormField'...
foreground - Foreground Color for the Definition 'JFormField'...
font - Font for the Definition 'JFormField'...
hintText - Hint String [Optional]...
Returns:
Next row number [int]...

definition

public static int definition(JFormForm form,
                             int lineMode,
                             java.lang.String definition,
                             java.lang.String inName,
                             int row,
                             java.awt.Font font,
                             java.lang.String hint)
        This 'JHDD_IO' Utility is designed to create a Label Field [_LField] 'JFormField'
        and insert it into the current ShowPanel...
 
        Usage:
        1)      Convenience method to make the creation of a "Definition" object in the 
                Show Panel. This special _LField JFormField is setup with a unique name so
                that it may be dynamically removed from the show Panel when no longer
                 required...
        

Parameters:
form - Host 'JFormField' SubClass Reference...
lineMode - See 'definition' JavDoc...
definition - Label String...
inName - Definition _LField Field Name [String]...
row - Insert Row Number [int]...
font - Font for the Definition 'JFormField'...
hint - Hint String [Optional]...
Returns:
Next row number [int]...

definition

public static int definition(JFormForm form,
                             int lineMode,
                             java.lang.String definition,
                             java.lang.String inName,
                             int row,
                             java.lang.String hint)
        This 'JHDD_IO' Utility is designed to create a Label Field [_LField] 'JFormField'
        and insert it into the current ShowPanel...
 
        Usage:
        1)      Convenience method to make the creation of a "Definition" object in the 
                Show Panel. This special _LField JFormField is setup with a unique name so
                that it may be dynamically removed from the show Panel when no longer
                required...
        

Parameters:
form - Host 'JFormField' SubClass Reference...
lineMode - See 'definition' JavDoc...
definition - Label String...
inName - Definition _LField Field Name [String]...
row - Insert Row Number [int]...
hint - Hint String [Optional]...
Returns:
Next row number [int]...

filesDisplay

public static java.lang.String filesDisplay(java.lang.String path,
                                            java.lang.String extensionIn)
        This method is designed to produce a Display String of the files in the given 
        path with the specified extension...

        Kernel Usage:
        1)      DEBUG Method...
        2)      *this*.showFiles Method...
        

Parameters:
path - Full File Path, i.e. with Root and Folder Names...
extensionIn - DOS Style Extension Names to be displayed, e.g. "java"
Returns:
Files Display String...

filesExist

public static boolean filesExist(java.lang.String path,
                                 java.lang.String extensionIn)
        This method is designed to search the given directory for Files with the given 
        Extension. If one or more files are found, the return boolean is set to true...

        Kernel Usage:
        1)      The 'AppDB.setExecutionMode' to verify the existance of any '.java' files.
                If there are ".java" files, then the current Execution Mode is set to 
                "Development"...
        

Parameters:
path - String with Root and Folder Names...
extensionIn - DOS Style File Extension to serch for...
Returns:
Flag [boolean] as a function of the existence of a given extension in the given Path...

getAbsolutePath

public static java.lang.String getAbsolutePath(java.lang.String inPath,
                                               java.lang.String category,
                                               java.lang.String fileName,
                                               java.lang.String extension)
        This method is designed to return the 'absolutePath' String for the File 
        Specified by the given File Parameters,e.g. inPath, Category, ...

        Kernel Usage:
        1)      'JFormForm.Constructor' to setup the Work Sheet Sub-Folder for a 
                'JFormForm' SubClass if it dooes not exist or is outdate...
        2)      'JFormForm.Constructor' to produce a Soft Abort message when the ".java"
                file for a 'JFormForm' SubClass can not be found when attempting to re-Build
                a WorkSheet file...
        

Parameters:
inPath - Root String, e.g. C:/jFormTKTest/
category - Category [String]...
fileName - Form Name [String]...
extension - File Name Extension if looking for a specific file...
Returns:
Absolute Path String

exitApplication

public static void exitApplication(JFormForm form)

getAppImagesJAR

public static JarResources getAppImagesJAR(java.lang.String from)
        Return the 'JarResources' instance for the Application Images JAR...

        Kernel Usage:
        1)      'JDoc.createDocumentationFiles' Method...
        2)      'JDoc.JImageControl.getImageIcon' Method...
        

Parameters:
from - DEBUG from method annotation...
Returns:
The current 'appImagesJAR' file as setup by 'setJARImages' durint the 'jFormTK' App Initialization phase...

getJFormTKImagesJAR

public static JarResources getJFormTKImagesJAR(java.lang.String from)
        Return the 'JarResources' instance for the 'jFormTK' Kernel Images JAR...

        Kernel Usage:
        1)      'JDoc.createDocumentationFiles' Method...
        

Parameters:
from - DEBUG from method annotation...
Returns:
The current 'jFormTKImagesJAR' file as setup by 'setJARImages' durint the 'jFormTK' App Initialization phase...

getFileDate

public static long getFileDate(java.lang.String inPath,
                               java.lang.String category,
                               java.lang.String fileName,
                               java.lang.String extension)
        Return a long Integer that contains the 'lastModified' Date for the File 
        Specified by the given File Parameters, e.g. inPath, Category, ...

        If the file does not exist,
        Then return a 'long' -1...

        Kernel Usage:
        1)      The 'JFormForm' Constructor uses this method to determine if a new 
                "Work Sheet" File shall be built, i.e. if the date of the current WorkSheet
                File is less than the date of the 'java file for *this* Form, then a new
                Work Sheet file is Dynamically built... 
        

Parameters:
inPath - File Root Parameter String, e.g. "C:/"...
category - Category String...
fileName - File Name [String] to locate...
extension - File Name DOS Style Extension, e.g. ".java"...
Returns:
Given File's "Last Modified" Date...

getImageFiles

public static java.io.File[] getImageFiles(java.lang.String folderPath,
                                           java.lang.String annotation,
                                           boolean debug)
        Return an Array of File instances = f[folderPath] parameter...

        Kernel Usage:
        1)      'JDoc.processOrderFile' Method to verify the 'order.txt' file existence...
        2)      'JDoc.createDocumentationFiles' for 'hddFileNamesArray'...
        3)      'JDoc.createDocumentationFiles' for 'hddSubTabNamesArray'...
        4)      'JDoc.createDocumentationFiles' for 'hddSubTabNames'...
        

Parameters:
folderPath - String with the Absolute Path to a HDD Holder...
Returns:
File Array derived from 'folderPath' parameter...

getFolderFiles

public static java.io.File[] getFolderFiles(java.lang.String folderPath)
        Return an Array of File instances = f[folderPath] parameter...

        Kernel Usage:
        1)      zzzz
        

Parameters:
folderPath - String with the Absolute Path to a HDD Holder...
Returns:
File Array derived from 'folderPath' parameter...

getFolderFiles

public static java.io.File[] getFolderFiles(java.lang.String folderPath,
                                            java.lang.String annotation,
                                            boolean debug)

getFormsFilePath

public static java.lang.String getFormsFilePath(JFormForm form)
        Create a "Forms File Path" String given a 'JFormForm' instance.
 
        Kernel Usage:
        1)      This signature is not currently used by the 'jFormTK' Kernel...
        

Parameters:
form - A 'JFormForm' instance...
Returns:
String with the given JFormForm's File Path...

getFormsFilePath

public static java.lang.String getFormsFilePath(java.lang.String category,
                                                java.lang.String fileName)
        Create a "Forms File Path" String given a the Category, 
        and Form File Name parameters. The Form File Root shall use the Application
        Data Base [AppDB] 'getFormsRoot' method parameter...

        Kernel Usage:
        1)      This 'JHDD_IO' revert Method...
 

Parameters:
category - Category String...
fileName - File Name [String] to locate...
Returns:
String with the given JFormForm's File Path...

getIcon

public static javax.swing.ImageIcon getIcon(java.lang.String fileName,
                                            java.lang.String from)
        Return an ImageIcon as a function of the the given File Name parameter
        [fileName].
        
        NOTE:
        The 'JHDD_IO.getImage' method is used to fetch the requested image.
        If an image is found, then the image is converted to a Java Image Icon...

        Kernel Usage:
        1)      This JHDD_IO utility is used in several 'jFormTK' Kernel Classes
                whenever an Image Icon is required...
        

Parameters:
fileName - File Name [String] of Image Icon to be retrieved...
from - DEBUG method reference String...
Returns:
Constructed 'ImageIcon'...

getImage

public static java.awt.Image getImage(java.lang.String fileNameIn,
                                      java.lang.String from)
        Return an 'Image' as a function of the the given File Name parameter
        [fileName]...

        If No Image if found in the 'jFormTK' 3 tiers for the specified File Name
        Then
                return the AppDB.NoFile Image from the 'jFormTKImages.jar' iff the
                'jFormTKImages.jar' exist.

        Produce a Software TRAP otherwise...

        The following hierarchy is used to create the return Object:
        1)      The Application / images HDD Folder...
        2)      The ApplicationImages JAR File, e.g. SLPlusImages.jar...
        3)      the 'jFormTK' Images JAR File. i.e. jFormTKImages.jar...

        Kernel Usage:
        1)      The 'this'.getIcon method to get an Image instance to be converted to
                the Java 'ImageIcon' Format...
        2)      'ImagePanel' Class Constructor...
        

Parameters:
fileNameIn - The Image File Name to retrieve...
Returns:
An 'Imasge' file...

XXXgetLastImageType

public static int XXXgetLastImageType()
        Return the current 'lastImageType' int...
        NOTE:
        This control is set by the 'this.getImage' method =f[jFormTK Images Tier]
        retrieval. The setting are as follows:
                0       -       HDD 'images' Folder...
                1       -       'appImagesJAR' File...
                2       -       'jFormTKImagesJAR' File...

        Kernel Usage:
        1)      zzzz
        

Returns:
Current 'lastImageType' int...

getSystemProp

public static java.lang.String getSystemProp()
        Create a Java String that displays the System Properties, one pre line,
        of the current execution host platform...

        Kernel Usage:
        1)      'JHDD_IO.showSystemProp' method...
        2)      'BasejFormTK.Menu.actionPerformed' method...
 

Returns:
String with the System Properties presented...

insertBlankLine

public static void insertBlankLine(JFormForm form,
                                   java.lang.String name,
                                   int row)
        Insert a blank line into the given 'JFormForm' [form] at the specified Row.

        NOTE:
        This method is generally only called by the 'JHDD_IO.doLine' method as a
        function of the 'lineMode' control.

        The 'Name' String is used to create the 'space' 'FormObject' with a "s" prefix
        so that the inserted blank line may be removed dynamically by the 
        'JHDD_IO.emoveQuery' method...
 

Parameters:
form - Reference to the 'host' JFormForm SubClass...
name - Name [String] to be used to construct the Blank Line 'JFormField' instance'. Usuall the 'Query' Name...
row - Row number [int] to insert the created Blank Line JFormField...

insertBlankLine

public static void insertBlankLine(JFormForm form,
                                   java.lang.String name,
                                   java.awt.Color background,
                                   int row)
        Insert a blank line into the given 'JFormForm' [form] at the specified Row.

        NOTE:
        This method is generally only called by the 'JHDD_IO.doLine' method as a function
        of the 'lineMode' control.

        The 'Name' String is used to create the 'space' 'FormObject' with a "s" prefix
        so that the inserted blank line may be removed dynamically by the 
        'JHDD_IO.emoveQuery' method...
 

Parameters:
form - Reference to the 'host' JFormForm SubClass...
name - Name [String] to be used to construct the Blank Line 'JFormField' instance'. Usuall the 'Query' Name...
background - Background Color for the insderted Blank Line's JFormField...
row - Row number [int] to insert the created Blank Line JFormField...

insertHorizontalRule

public static void insertHorizontalRule(JFormForm form,
                                        java.lang.String name,
                                        int row)
        Insert a Horizontal Rule into the given 'JFormForm' [form] at the specified Row.

        NOTE:
        This method is generally only called by the 'JHDD_IO.doLine' method as a
        function of the 'lineMode' control.

        The 'Name' String is used to create the 'space' 'FormObject' with a "s" prefix
        so that the inserted blank line may be removed dynamically by the 
        'JHDD_IO.emoveQuery' method...
        

Parameters:
form - Reference to the 'host' JFormForm SubClass...
name - Name [String] to be used to construct the Blank Line 'JFormField' instance'. Usuall the 'Query' Name...
row - Row number [int] to insert the created Blank Line JFormField...

isFile

public static boolean isFile(java.lang.String path)
        If there is a file for the current 'JFormForm' on the storage device,
        then the return flag is set to true. Else a false flag is returned...

        Kernel Usage:
        1)      'JFormState.isFile' Method...
 

Parameters:
path - File Path String of the 'JFormForm' SubClass to be checked...
Returns:
Flag [boolean] as a function of the given File's existence...

isFile

public static boolean isFile(java.lang.String category,
                             java.lang.String fileName)
        If there is a file for the current 'JFormForm' on the storage device,
        then the return flag is set to true. Else a false flag is returned...

        Kernel Usage:
        1)      Used by the 'JFormField' Constructor to determine if the new 'JFormField' 
                shall be loaded from a "Saved" File...
 

Parameters:
category - Category String...
fileName - File [Form] Name String...
Returns:
Flag [boolean] as a function of the given File's existence...

isFile

public static boolean isFile(java.lang.String inPath,
                             java.lang.String category,
                             java.lang.String fileName,
                             java.lang.String extension)
        Determine if there exist a File for the given File Paremeters...

        Kernel Usage:
        1)      The 'JFormForm' Constructor uses this method to determine if a 
                "Work Sheet" File Exist for the associated 'JFormForm' SubClass...
        2)      The 'JFormForm' Constructor uses this method to determine if there are 
                '.java' OR 'jar" Files in the 'jFormTK' Application Work Space. The 
                existence of these files determines where the 'jFormTK' Kernel shall 
                find the WorkSheet Files... 
 

Parameters:
inPath - File Path including the HDD Root, e.g. "C:/jFormTKTest/"
category - Category String...
fileName - File [Form] Name String...
extension - File DOS Style Extension, e.g. "java"
Returns:
Flag [boolean] as a function of the Files Existence...

nextField

public static void nextField()

query

public static int query(JFormForm form,
                        int lineMode,
                        java.lang.String prompt,
                        java.lang.String inName,
                        int row,
                        java.lang.String hint)
        Produce a '_LField' and a '_BField' [and an optional 'Space'] 
        'JFormField' to present a Query to the Application End User with a 'YES' 
        Action Button Option...

        where 'inName' is used to create JFormField's as follows:
                -       'l'+inName OR 's'+inName OR 'a'+inName are _LField 'JFormField's 
                        inserted to produce Prompt or space lines as a function of the
                        'lineMode'.
                -       'b'+inName to create the Action Button [_BField] with the "Yes" 
                        annotation...

        Kernel Usage:
        None    This method is designed for use by the 'jFormTK' Application Developer
                        to ease the setup of Dynamic 'JFormField' Entries...
        

Parameters:
form - Host 'JFormForm' SubClass Reference...
lineMode - See this 'definition' JavaDoc for 'lineMode' definition...
prompt - Query Prompt String...
inName - Query 'JFormField' Name [see Note Above]...
row - Insert Row [int]...
hint - Hint Button Text String...
Returns:
Next Row Number [int]...

query

public static int query(JFormForm form,
                        int lineMode,
                        java.lang.String prompt,
                        java.lang.String inName,
                        int row,
                        java.awt.Font font,
                        java.lang.String hint)
        Produce a '_LField' and a '_BField' [and an optional 'Space'] 
        'JFormField' to present a Query to the Application End User with a 'YES' 
        Action Button Option...

        where 'inName' is used to create JFormField's as follows:
                -       'l'+inName OR 's'+inName OR 'a'+inName are _LField 'JFormField's 
                        inserted to produce Prompt or space lines as a function of the
                        'lineMode'.
                -       'b'+inName to create the Action Button [_BField] with the "Yes" 
                        annotation...

        Kernel Usage:
        None    This method is designed for use by the 'jFormTK' Application Developer
                        to ease the setup of Dynamic 'JFormField' Entries...
        

Parameters:
form - Host 'JFormForm' SubClass Reference...
lineMode - See this 'definition' JavaDoc for 'lineMode' definition...
prompt - Query Prompt String...
inName - Query 'JFormField' Name [see Note Above]...
row - Insert Row [int]...
font - Query Prompt Font [Font]...
hint - Hint Button Text String...
Returns:
Next Row Number [int]...

query

public static int query(JFormForm form,
                        int lineMode,
                        java.lang.String prompt,
                        java.lang.String inName,
                        int row,
                        java.awt.Color background,
                        java.awt.Color foreground,
                        java.awt.Font font,
                        java.lang.String hint)
        Produce a '_LField' and a '_BField' [and an optional 'Space'] 
        'JFormField' to present a Query to the Application End User with a 'YES' 
        Action Button Option...

        where 'inName' is used to create JFormField's as follows:
                -       'l'+inName OR 's'+inName OR 'a'+inName are _LField 'JFormField's 
                        inserted to produce Prompt or space lines as a function of the
                        'lineMode'.
                -       'b'+inName to create the Action Button [_BField] with the "Yes" 
                        annotation...

        Kernel Usage:
        None    This method is designed for use by the 'jFormTK' Application Developer
                        to ease the setup of Dynamic 'JFormField' Entries...
 

Parameters:
form - Host 'JFormForm' SubClass Reference...
lineMode - See this 'definition' JavaDoc for 'lineMode' definition...
prompt - Query Prompt String...
inName - Query 'JFormField' Name [see Note Above]...
row - Insert Row [int]...
background - Query Prompt Background Color [Color]...
foreground - Query Prompt Foreground Color [Color]...
font - Query Prompt Font [Font]...
hint - Hint Button Text String...
Returns:
Next Row Number [int]...

query

public static int query(JFormForm form,
                        int lineMode,
                        java.lang.String prompt,
                        java.lang.String inName,
                        int row,
                        java.awt.Color background,
                        java.awt.Color foreground,
                        java.awt.Font font,
                        java.lang.String hint,
                        java.awt.Color bBackground,
                        java.awt.Color bForeground,
                        java.awt.Font bFont)
        Produce a '_LField' and a '_BField' [and an optional 'Space'] 
        'JFormField' to present a Query to the Application End User with a 'YES' 
        Action Button Option...

        where 'inName' is used to create JFormField's as follows:
                -       'l'+inName OR 's'+inName OR 'a'+inName are _LField 'JFormField's 
                        inserted to produce Prompt or space lines as a function of the
                        'lineMode'.
                -       'b'+inName to create the Action Button [_BField] with the "Yes" 
                        annotation...

        Kernel Usage:
        None    This method is designed for use by the 'jFormTK' Application Developer
                        to ease the setup of Dynamic 'JFormField' Entries...
 

Parameters:
form - Host 'JFormForm' SubClass Reference...
lineMode - See this 'definition' JavaDoc for 'lineMode' definition...
prompt - Query Prompt String...
inName - Query 'JFormField' Name [see Note Above]...
row - Insert Row [int]...
background - Query Prompt Background Color [Color]...
foreground - Query Prompt Foreground Color [Color]...
font - Query Prompt Font [Font]...
hint - Hint Button Text String...
bBackground - "YES" Button Background Color [Color]...
bForeground - "YES" Button Foreground Color [Color]...
bFont - "YES" Button Font [Font]...
Returns:
Next Row Number [int]...

readBreakpointLOG

public static java.util.Vector readBreakpointLOG()
        Read the Breakpoint LOG file from the Application's Root Directory...

        Kernel Usage:
        1)      Called from 'BasejFormTK.getActiveBreakpointLOG' Method...
 

Returns:
Vector containing the "Breakpoint LOG...

readFileControls

public static java.lang.String[] readFileControls(java.lang.String category,
                                                  java.lang.String fileName)
        Read the "Saved" Strings for the File Controls, 
        i.e. the "Saved" Strings for the "JFormInfo", "GroupControls", "HighliteControls",
        "QuickEdits" and "JFormState" Controls...

        Kernel Usage:
        1)      Used by the 'JFormForm' Constructor iff the 'isFile' is 'true' to set 
                the controls for the new instance of a Form as a function of the previously
                saved 'JFormForm' SubClass File...
 

Parameters:
category - Category String...
fileName - Form File Name String...
Returns:
String Array containing the above Saved Components Saved Parameters...

readFormFields

public static boolean readFormFields(JFormForm form,
                                     java.lang.String from)
        Read the "savedJFormField" Strings for each 'JFormField' of the given 
        'JFormForm', transform each to a 'JFormField' of the 'formFields' Vector...
 
        Kernel Usage:
        1)      'AppForms.getJFormFieldActiveNames' Method...
        2)      'AppForms.getValue' Method...
        3)      'AppForms.isFieldName' Method...
        4)      'JFormFrame.loadFormFieldsVector' Method...
        5)      'Util.getJFormField' Method...
        6)      'JFormForm.getFormFields' Method...
        

Parameters:
form - Reference to the host 'JFormForm' SubClass instance...
from - DEBUG String to indicate the calling method...
Returns:
Boolean flag to indicate if the Form Fields were successfully loaded...

readJAddressBook

public static int readJAddressBook(JAddressBook aBook)
        This 'jFormTK.JHDD_IO' Method is designed to load the current
        'JAddressBook' from the Application Designated Hard Drive Devise [HDD].
        If no 'JAddressBook' exist,
        Then the return index is set to '-1'...

        Kernel Usage:
        1)      'AppDB.initialize' Method while setting up the App Data Bases...
        

Parameters:
aBook - The 'JAddressBook' instance to be loaded...
Returns:
The Number of Items in the loaded Address Book [int]...

readObject

public static java.lang.Object readObject(java.lang.String fileName)
        This method is designed to read an 'Object' from the File Name specified
        [fileName] at the Application Root Directory...

        Kernel Usage:
        1)      'JRegistration.processRegistry' Method to read the Application's Registry
                File [e.g. BNY-00004936] from the Application 'Root' Folder...
        2)      'JRegistration.verifyApplication' Method to read the Application 'Registered
                User" file [e.g. crowell.reg] from the App Root Folder...
        

Parameters:
fileName - File Name String
Returns:
The read Object instance...

readTextFile

public static java.lang.String[] readTextFile(java.lang.String path)
        read a Text File from the HDD given an Absolute File path...

        Kernel Usage:
        1)      'JDoc.createDocumentationFiles' method when a 'jFormTK' Documentation "Order"
                Folder is processed... 
        

Parameters:
path - Absolute File path to the Text File to be read...
Returns:
String Array with an element for each line of the Text File...

readTextFileIntoString

public static java.lang.String readTextFileIntoString(java.lang.String path)
        Read a Text File from the HDD given an Absolute File path into a return String
        with the 'JConstants.LF' inserted after each line...

        FYI:
        If the given Text File was constructed from a Word Processing Document [e.g. a
        Microsoft Word .Doc file] you should export the .txt file to the "MS-DOS Text with
        Line Breaks" format. In this format any "Open Quote" OR "Close Quote" characters
        shall be converted to the "Double Quote" character. The "Double Quote" character is
        generally used during the "'jFormTK' Message Style" process to control the
        quoted String Look and Feel and to keep the "quote" characters in the "Styled"
        String.

        If you export to the "Text with Line Breaks" format the "Open Quote" OR "Close Quote"
        conversion is not performed and the "'jFormTK' Message Style" process does not
        recognize "Open Quote" OR "Close Quote" characters.

        Note that the "Open Quote" OR "Close Quote" characters do not have keys on the standard
        Windows or Mac keyboards and were made available via some Word Processor processing.

        Kernel Usage:
        1)      'JDocumentation.showSlides' method when a Non-Image .txt is found in the
                current Slide Set. Thid methos shall read the .txt file [path] into a
                single return String suitable for display in a JTextPane...
        

Parameters:
path - Absolute File path to the Text File to be read...
Returns:
String Array with an element for each line of the Text File...

XXXreadWorkSheet

public static JWorkSheet XXXreadWorkSheet(JFormForm form)
        Read the 'JWorkSheet' File of the WorkSheets' Application Folder that is
        associazated with the given 'JFormForm' SubClass instance...

        Kernel Usage:
        1)      'JFormWorkSheets.processPrint' METHOD...???????
 

Parameters:
form - The 'JFormForm' SubClass Instance...
Returns:
A 'JWorkSheet' instance...

redrawPage

public static void redrawPage(JFormForm form,
                              JFormField fld)
        This metod is designed to redraw the specific 'FormForm' with the cursor 
        located at the specified 'JFormField'. This method MUST be used in lieu of the 
        'showPage' Method when the Form [form] has been changed during the 'jFormTK' 
        Application execution, i.e. in run-time...

        Kernel Usage:
        1)      Used in a 'jFormTK' Developers sub-class of the 'JFormForm' Class.
                Designed for usage in the 'DoButton' and / or pre / post Processor override 
                methods when the fields of the form are adjusted during the Application 
                run-time...
        2)      Called from the 'JFormFrame.addGroupSet' method to re-display the 'showPanel'
                after an Application's 'Group' has been increased...
        3)      Called from the 'JFormFrame.deleteGroup' method to re-display the 'showPanel'
                after an Application's 'Group' Sets hae been decreased...
        4)      'JAddressBook.AddressBookRemove.doRemoveYes' Method... ???
        5)      'JFormFrame.nextGroupSet' method...
        6)      'JFormWorkSheets.processPrint' method...
 

Parameters:
form - Current 'JFormForm' SubClass instance...
fld - 'JFormField' instance to receive the Focus...

removeDefinition

public static void removeDefinition(JFormForm form,
                                    java.lang.String definitionName)
        Remove the definition JFormField's from the given 'JFormForm' form. The 
        JFormField names to be removed are derived from the given Name [inDefinitionName]...

        Kernel Usage:
        1)      Called from the 'JFormForm' Sub-Class 'DoButton' Method when the associated 
                Definition has been answered in the affirmative... 
        

Parameters:
form - Currejt 'JFormForm' SubCoass instance...
definitionName - Name [String] to be removed from the efinitions...

removeQuery

public static void removeQuery(JFormForm form,
                               java.lang.String queryName)
        Remove the query JFormField's from the given 'JFormForm' form. The 
        JFormField's to be are constructed from the given 'queryName' parameter...
 
        Kernel Usage:
        1)      Called from the 'JFormForm' Sub-Class's 'DoButton' Method when the associated
                Query has been answered in the affirmative... 
        

Parameters:
form - Host 'JFormForm' SubClass instance...
queryName - Query Name used to construct the 'JFormField' names to remove...

revert

public static void revert(JFormForm form)
        Set the current 'JFormForm' file to the 'revert' File and set the 'revert' File
        to the current File, i.e. swap the two files. Also, set the 'DateModified' and 
        'revertFileDate' 'JFormInfo' files accordingly...

        Kernel Usage:
        1)      Used by the 'JFormFrame.verifyForm' Method when the user has selected a new 
                Form without doing a "Save" of the current File and has selected the 
                "revert" Option...
 

Parameters:
form - The current 'JFormForm' SubClass instance...

setJarResources

public static void setJarResources(java.lang.String appFolder)
        Build the 'JarResources' object for the Application Images Jar file
        [e.g. SLPlusImages.jar] and the 'jFormTK' deployment Images Jar file
        [jFormTKImages.jar]...

        If the respective Jar Files are not found via the System.getProperty("java.class.path)
        Then the JHDD_IO private parameters are 'Null' and any "get" Image'jFormTK'
                process shall NOT look for the requested image in the 'null' Jar Resource...

        NOTE:
        The above 'If' condition allows a 'jFormTK' Application to run if the
        full 3 Tier Image Fetch process is NOT present...

        Kernel Usage:
        1)      'jFormTK.Main.init' Method...
        

Parameters:
appFolder - Application Acronym, e.g. "SLPlus"... NOTE: This is the 'appFolder' arg[2] value which has a file delimiter prefix that is Striped for this purpose...

showFiles

public static void showFiles(java.lang.String path,
                             java.lang.String extension)
        Produce a message Dialog listing of the files in the given 
        path with the specified extension...
 
        Kernel Usage:
        1)      DEBUG Method...
        

Parameters:
path - File Path String...
extension - DOS style File Extension

showPage

public static void showPage(JFormForm form,
                            JFormField focusFld,
                            java.lang.String from)
        This method is designed to show the given 'JFormForm' SubClass in the 'jFormTK'
        Show Panel [form] and to set the 'JFormField' Focus on the specified field
        [targetFieldIn]...

        Kernel Usage:
        NOTE:
                This method is used throughout the 'jFormTK' Kernel whenever a 'JFormForm'
                SubClass shall be displayed OR re-displayed following a dynamic change to
                one or more fields in the Show Panel... 
        1)      '*this*.redrawPage' Method...
        2)      'AddressBook.doProceed' Method...
        3)      'AppForms.loadJFormForm' Method...
        4)      'QuickEditDialog.doGoTo' Method...
        5)      'JAddressBook.doGoToForm' Method...
        6)      'JFormFrame.backSet' Method...
        7)      'JFormFrame.nextSet' Method...
        8)      'JFormFrame.ControlsButtonAction.actionPerformed' Method...
        

Parameters:
form - The 'JFormForm' SubClass Form to be displayed.
focusFld - The 'JFormField' instance to receive the Focus///
from - String annotation of the envoking Class.Method [DEBUG]...

showSystemProp

public static void showSystemProp()
        Create a Dialog Window that displays    the System Properties...
 
        Kernel Usage:
        1)      Method to display the System Parameters from the Debug Menu...
        2)      In 'jFormTK' Application 'jFormTK' Sub-Class Classes as required for 
                DEBUG...
 


writeBreakpointLOG

public static void writeBreakpointLOG(java.util.Vector log)
        Write the Breakpoint LOG file to the Application's Root Directory...

        Kernel Usage:
        1)      Called from 'BasejFormTK.addBreakpointLOG' Method each time a new Breakpoint
                is Added to the Breakpoint LOG...
        2)      Called from 'BasejFormTK.removeBreakpointLOG' Method each time a Breakpoint
                is removed from the Breakpoint LOG...
        

Parameters:
log - Current 'Breakpoint LOG' Vector maintained by 'BasejFormTK' class...

writeJAddressBook

public static boolean writeJAddressBook()
        Write the Application Data base [AppDB] Address Book to the HDD...

        Kernel Usage:
        1)      'AppCommonDB.updateItems' method...
        2)      'Util.assignment' method...
        3)      'Util.setAField' method...

Returns:
Flag [boolean] indication the success of the Write Operation...

writeJAddressBook

public static boolean writeJAddressBook(JAddressBook aBook)
        Write the given 'JAddressBook' to the Form Device...

        Kernel Usage:
        1)      Called from the '*this*.writeToForm' Method...
        2)      'JAddressBook.add' Method...
        3)      'JAddressBook.remove' Method...
        4)      'JAddressBook.setName' Method...
        5)      'JAddressBook.setParameters' Method...
        6)      'JAddressBook.AddressBookReferenceDialog.doOK Method...
        7)  'JAddressBook.AddressBookRemove.setParameters' Method...
        8)      'Main.init' Method...
        

Parameters:
aBook - 'JAddressBook' instance to be written to the HDD...
Returns:
Flag [boolean] on success of write to HDD operation...

writeObject

public static boolean writeObject(java.lang.Object object,
                                  java.lang.String fileName)
        Write the given Object [object] to the specified HDD FileName...

        Kernel Usage:
        1)      'JRegistration.processRegistry' method to write the "Registered Name.reg"
                file...
        2)      Called from the 'Registry' Project to create a "User Specific"
                'Registration File...
        2)      '*this*.readBreakpointLOG' Method...  
 

Parameters:
object - The Java Object to be written to the HDD...
fileName - The name [String] of the receiving File...
Returns:
Flag [boolean] for the success of the Write operation...

writeToForm

public static int writeToForm(JFormForm form,
                              java.lang.String from)
        Write the given JFormForm and it's 'JFormInfo' / 'JFormState' Fields to the
        storage device. Return an integer that provides the following values:
                = -1 Error Occurred
                = 'AppForms' Index if the "Write To File" was Successful...

        The operations used to perform the 'writeToForm' request is a function of the
        current 'loadState' of the given 'JFormForm'...

        If the 'loadState' is "Active Form State" ['A']
        Then the 'jFormFields' Vector is constructed as follows:
                Element 1: The 'JFormInfo' "savedJFormInfo" String...
                Element 2: The 'JFormInfo' "savedGroupControls String...
                Element 3: The 'JFormInfo' "savedHighliteControls String...
                Element 4: The 'JFormInfo' "savedQuickEdits String...
                Element 5: The 'JFormState "savedJFormState" String...
                Element 6-n: The 'jFormFields' Vector for the current is constructed from the
                        'jFormTK.showPanel', i.e. a 'savedJFormField' String is set for each
                        'JFormField' of the current 'showPanel'...

        The 'jFormFields' Vector is then written to the 'Category.FileName'
        file as specified in the AppDB.AppForms Element assigned to this 'JFormForm'.

        If the 'loadState' is "Data Request State" ['D' OR 'U']
        Then the 'jFormFields' Vector already contains the current 'JFormField' Strings in
        Elements 5-n. The "saved..." Strings for the 'AppDB.appForm', 'JFormInfo', 
        'GroupControls', 'HighliteControls' and 'JFormState' items are now re-set in
        'jFormFields' Element's 0-3 as described above.

        The 'jFormFields' Vector is then written to the 'Category.FileName'
        file as specified in the AppDB.AppForms Element assigned to this 'JFormForm'.

        Once the Write To File is successful, the newly constructed 'jFormFields' Vector
        remains in memory until the 'jFormTK' Application is exited. This is done so
        that any reference to a 'JFormField' of this 'JFormForm' may be accomplished
        without re-reading the data from the storage device.

        Prior to envoking the 'this.writeForm' method the 'jFormFields' vector of
        saved 'JFormField' is conditionally processed as a function of the
        'JFormInfo.eCrypt' parameter. If 'eCrypt' is NOT the Null String,
        then each 'value' of each "Active JFormField" [see Util.isActive method] is
        encrypted iff the 'JFormField.crypt' flag is true...

        NOTE: [This note MAY not apply anymore. The 'U' Load State is no longer required...
        If any changes are made to the 'jFormFields' Vector while in the "Data Request
        State", the 'loadState' Control is changed from ['D'] to ['U']. It is the
        responsibility of the 'jFormTK' Method that modified any 'jFormFields' Element to
        change the 'loadState' to 'U'. The 'U' 'loadState' is used in the "Application
        Exit" Phase and in the "Load 'JFormForm' from 'jFormFields'" Phase of the Java 
        Form Tool Kit [jFomrTK] processing...

        Kernel Usage:
        1)      'JFormFrame.nextGroupSet' Method to save the current 'JFormForm' Sub-Class
                to ensure that the 'init' method is not envoked a second time...
        2)      'JFormFrame.loadFormFieldsVector' Method to ensure that the 'formFields'
                Vector setup by the 'JFormForm' Sub-Class is saved...
        3)      'JFormFrame.verifySaveForm' Method when the End User has requested a Save from
                the 'QuitNotSaved' Dialog...
        4)      'JFormFrame.doSave' Method when the Application End User has pressed the
                Button Panel "Save" button...

Parameters:
form - The 'JFormForm' SubClass to write to Storage...
from - DEBUG String annotating the calling program
Returns:
An int [see above] to indicate successful write operation...

writeWorkSheet

public static boolean writeWorkSheet(JWorkSheet ws,
                                     java.lang.String category,
                                     java.lang.String fileName)
        Write the given Work Sheet File to the HDD...

        Kernel Usage:
        1)      Called from the '*this*.showPage' Method when the "Work Sheet" File is
                flagged as a "Shell" so that the Work Sheet shall be created OR updated...
 

Parameters:
ws - JWorkSheet instance to write to the HDD...
category - Category String...
fileName - JFormForm SubClass File Name String...
Returns:
Flag [boolean] for success of write operation...

writeWorkSheet

public static boolean writeWorkSheet(JWorkSheet ws,
                                     JFormForm form)
        Write the given Work Sheet File to the HDD...

        Kernel Usage:
        1)      This signature is Not currently used...
 

Parameters:
ws - JWorkSheet instance to write to the HDD...
form - 'JFormForm' SubClass instance...
Returns:
Flag [boolean] for success of write operation...

writeWorkSheet

public static boolean writeWorkSheet(JWorkSheet ws,
                                     java.lang.String workSheetRoot,
                                     java.lang.String category,
                                     java.lang.String fileName)
        Write the given Work Sheet File to the HDD...

        Kernel Usage:
        1)      This signature is Not currently used...
 

Parameters:
ws - JWorkSheet instance to write to the HDD...
workSheetRoot - Work Sheet Root String...
category - Category String...
fileName - JFormForm SubClass File Name String...
Returns:
Flag [boolean] for success of write operation...