com.jFormTK
Class JFormForm

java.lang.Object
  extended by com.jFormTK.JFormForm
All Implemented Interfaces:
JConstants
Direct Known Subclasses:
Main.HelloWorld

public class JFormForm
extends java.lang.Object
implements JConstants

This jFormTK Class is designed to contain the parameters for each "Form" of a Java Form Tool Kit [jFormTK] Application... The 'jFormTK' Application Developer SHALL create a "sub-class" of this class for each form in the 'jFormTK' Application...

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

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

Nested Class Summary
 class JFormForm.DisplayHelp
           
 class JFormForm.DisplayHint
           
 class JFormForm.DisplayTADialog
           
 
Field Summary
protected  java.util.Vector formFields
           
protected  JFormInfo info
           
 
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, C_QUOTE, 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
JFormForm(java.lang.String inCategory, java.lang.String inFileName, java.lang.String inNC, java.lang.String inNR, java.lang.String inTitle)
           Constructor that is used by the 'End User' to establish the JFormForm Control Parameters specified in the parameters list and to initialize the *this* 'JFormInfo', 'JFormState' and 'WorkSheet' Fields as a function of the 'isFile' Status...
JFormForm(java.lang.String inCategory, java.lang.String inFileName, java.lang.String inNC, java.lang.String inNR, java.lang.String inTitle, java.lang.String built_In_Test)
           Constructor that is used by the 'End User' to establish the JFormForm Control Parameters specified in the parameters list and to initialize the *this* 'JFormInfo', 'JFormState' and 'WorkSheet' Fields as a function of the 'isFile' Status...
JFormForm(java.lang.String inCategory, java.lang.String inFileName, java.lang.String inNC, java.lang.String inNR, java.lang.String inTitle, java.lang.String built_In_Test, java.lang.String focus_Trace)
           Constructor that is used by the 'End User' to establish the JFormForm Control Parameters specified in the parameters list and to initialize the *this* 'JFormInfo', 'JFormState' and 'WorkSheet' Fields as a function of the 'isFile' Status...
 
Method Summary
static double[][] buildTableLayoutSize(java.lang.String id, int rowHeight, int nCols)
           Build the 'size' double array that is required by the 'TableLayout' Constructor.
 void decrementHasJFormFieldHighlitedLAF()
           
 java.lang.String displayElements()
           Return a display string to show the Form ID for each 'JFormField' of the 'jFormFields' Collection.
 java.lang.String doButton(JFormField fld, java.lang.String flowControlIn)
           This method is designed to satisfy the Java Compiler for the 'doButton' Method.
 java.lang.String doPerson(JFormField fld, java.lang.String flowControlIn)
           This method is designed to satisfy the Java Compiler for the 'doPerson' Method.
 java.lang.String doQuery(JFormField fld, java.lang.String flowControlIn, java.lang.String from)
           This method is designed to satisfy the Java Compiler for the 'doQuery' Method.
 boolean equals(JFormForm inForm)
           compare the current 'JFormForm' with the given 'JFormForm' and return the appropriate boolean Flag...
 int findCurrentJFormField(JFormField fld)
           Return the index for the given 'JFormField' in the current 'JFormForm Sub-Class Form Fields Vector...
 JFormField forceActiveFieldBefore(java.lang.String targetID)
           Get the "Active" JFormField at or BEFORE the given 'JFormField' ID...
 java.util.Vector getActiveFormFields()
           Get a Vector of the Active 'formFields'.
 java.lang.String getAtypicalDialogControl()
           
 boolean getBuilt_In_TestFlag()
           Get the "Built_In_Test" Flag for *this* 'JFormForm' Sub-Class...
 java.lang.String getCategory()
           Get the "Category" String for this 'JFormForm' Sub-Class.
static java.lang.String getFieldID(java.lang.String anchor)
           Get the 'JFormForm' ID...
 java.lang.String getFileName()
           Get the "FimeName" String for this 'JFormForm' Sub-Class.
 JFormField getFirstActiveJFormField()
           Return the first Active 'JFormField' of the host 'JFormForm' Sub-Class...
 boolean getFocusTraceFlag()
           Get the "Focus Trace" Flag for *this* 'JFormForm' Sub-Class...
 java.lang.String getFormFieldIDs(java.lang.String tab)
           
 java.util.Vector getFormFields(java.lang.String from)
           Get a "Reference" to the *this* 'formFields' Vector.
static java.lang.String getFormID(java.lang.String anchor)
           Get the 'JFormForm' ID as a function of the given JAddressBook Anchor...
 JFormInfo getFormInfo()
           Get the 'JFormField.JFormInfo' "Reference"...
 JFormState getFormState()
           Get the 'JFormForm.JFormState' "Reference"...
 java.util.Vector getGroupFields(java.lang.String groupNameIn, java.lang.String setNumberIn)
           Get a Vector of 'JFormField' "References" that match the Given Group Name [groupName] and Set Number [setNumberIn].
 JFormField[] getGroupJFormFields(java.lang.String groupName, int nFields, int setNumber)
           Produce and return an Array of 'JFormField' elements as a function of the given 'setNumber' int as follows: 1) setNumber >= 0 Return the 'JFormField' Array for the given Set Number...
 int getHasJFormFieldHighlitedLAF()
           
 JFormFieldLAFS getHighlitedLAF()
           Return the Highlited JLAF value...
 java.lang.String getID()
           Get the 'JFormForm' Unique "ID" String for *this* 'JFormForm' Object.
 java.util.Vector getIFields(int count)
           Construct a Vector of the current Forms '_IField' instances...
 JFormField getJFormField(java.lang.String inFldID)
           Get a 'JFormField' "reference for the given 'JFormField' ID String [inFldID].
 int getJFormFieldIndex(java.lang.String fldID)
          Get the Index of the given 'JFormField' ID for this 'JFormForm' Sub-Class...
 int getLastRowAdded()
           Get the "last row added" row number...
 JFormField getNextFocusedJFormField(java.lang.String currentID)
           Return the Next Active 'JFormField' following the given 'JFormField' ID String [currentID].
 NotePad getNotePad()
           Get a "Reference" to *this* JFormForm's 'NotePad' instance...
 int getNumberOfFields()
           Return the size of the current 'JFormFields' Vector...
 int getNumberOfNotes()
          Get the current 'number of Notes added to the associated 'NotePad' instance by the Applications End User...
 JFormField getPreviousFocusedJFormField(java.lang.String currentID)
           Return the Previous Active 'JFormField' following the given 'JFormField' ID String [currentID].
 java.lang.String getRange(java.lang.String mode)
           Create a String that contains the Start ID and End ID separated by DASH.
 java.util.Vector getRangeJFormFields(java.lang.String range)
           Build and return a Vector of 'JFormField' elements from the current 'JFormForm' Sub-Class as a function of the given 'range' Control.
 int getScrollAdjust()
           
 info.clearthought.layout.TableLayout getTableLayout()
           Get the current 'JFormForm' Show Panel's TabeLayout instance...
 javax.swing.tree.TreePath getTreePath()
          Get the 'JFormTree' Path to the Title Leaf...
 JWorkSheet getWorkSheet(java.lang.String from)
           Get the 'JFormForm.JWorkSheet' "Reference"...
 boolean getWorkSheetFlag()
           Get the JWorkSheet Flag for *this* 'JFormForm' Sub-Class...
 void incrementHasJFormFieldHighlitedLAF()
           
 void init()
           This method is designed to satisfy the Java Compiler for the init Method.
 boolean isCrypt()
           
 boolean isFlowControlMouseControl()
           
 boolean isFlowControlShiftTABKeyControl()
           
 boolean isFlowControlTABKeyControl()
           
static boolean isGroup(java.lang.String anchor)
           Return a boolean Flag to indicate if the 'JFormField' referenced by the given anchor is within a group...
 boolean isMouseContiguousFlag()
           
 boolean isPostMouseControl()
           
 boolean isPostShiftTABKeyControl()
           
 boolean isPostTABKeyControl()
           
 boolean isPostTABSelectControl()
           
 boolean isPreMouseControl()
           
 boolean isPreShiftTABKeyControl()
           
 boolean isPreTABKeyControl()
           
 void nullFocusChangeControls()
           This method is designed to set each of the Focus Change Controls to the null state, i.e.
 java.lang.String postProcessor(JFormField fld, java.lang.String flowControl)
           This method is designed to satisfy the Java Compiler for the 'postProcessor' Method.
 java.lang.String preProcessor(JFormField fld, java.lang.String flowControl)
           This method is designed to satisfy the Java Compiler for the 'preProcessor' Method.
 void setAtypicalDialogControl(java.lang.String s)
           
 void setBuilt_In_TestFlag(boolean flag)
           Set the "Built_IN_Test" Flag...
 void setCrypt(boolean flag)
           
 void setFlowControlMouseControl(boolean flag)
           
 void setFlowControlShiftTABKeyControl(boolean flag)
           
 void setFlowControlTABKeyControl(boolean flag)
           
 void setFocusTraceFlag(boolean flag)
           Set the "Focus Trace" Flag...
 void setFormFields(java.util.Vector v, java.lang.String from)
           Set the *this* 'formFields' Vector reference...
 void setFormInfo(JFormInfo iInfo)
           Set the local 'JFormInfo' Reference...
 void setFormLAF()
           This method is designed to set the Application "Look & Feel" Parameters...
 void setFormState(JFormState iState)
           Set the local 'JFormState' Reference
 void setHasJFormFieldHighlitedLAF(int i)
           
 CurrentFldControl setIndexBeforeHere(int currentJFormFieldIndex)
           Set the current JFormField and it's Form Fields Collection index to the Active Field before the current JFormField...
 CurrentFldControl setIndexFromEnd()
           Set the current JFormField and it's Form Fields Collection index to the last Active Field...
 CurrentFldControl setIndexFromHere(int currentJFormFieldIndex)
           Set the current JFormField and it's Form Fields Vector index to the next Active Field from the given 'currentJFormFieldIndex' control...
 CurrentFldControl setIndexFromStart()
           Set the current JFormField and it's Form Fields Collection index to the first Active Field...
 void setLastRowAdded(int newRow)
           Set the 'lastRowAdded' instance variable...
 void setMouseContiguousFlag(boolean flag)
           
 void setNotePad(NotePad inNotePad)
           Set the local 'NotePad' Redference...
 void setNumberOfNotes(int n)
           Set the 'number of Notes' local parameter...
 void setPostMouseControl(boolean flag)
           
 void setPostShiftTABKeyControl(boolean flag)
           
 void setPostTABKeyControl(boolean flag)
           
 void setPostTABSelectControl(boolean flag)
           
 void setPreMouseControl(boolean flag)
           
 void setPreShiftTABKeyControl(boolean flag)
           
 void setPreTABKeyControl(boolean flag)
           
 void setScrollAdjust(int i)
           
 void setTreePath(javax.swing.tree.TreePath inPath)
           Set the *this* TreePath instance that is used to service the 'jFormTK.Control' TAB Application Forms Tree...
 void showFORM()
          Show the parameters of the current 'JFormForm' Sub-Class...
 boolean verifyCurrentJFormFieldIndex(JFormField fld, int index)
           Verify that the given 'JFormField' exist in the specified element of the host 'JFormForn' Sub-Class 'JFormField' Vector...
 void XXXrequestFocus()
           'requestFocus' 'jFormTK' Override Method...
 void XXXsetWorkSheetFlag(boolean flag)
           Set the JWorkSheet Flag for *this* 'JFormForm' Sub-Class...
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

formFields

protected java.util.Vector formFields

info

protected JFormInfo info
Constructor Detail

JFormForm

public JFormForm(java.lang.String inCategory,
                 java.lang.String inFileName,
                 java.lang.String inNC,
                 java.lang.String inNR,
                 java.lang.String inTitle)
        Constructor that is used by the 'End User' to establish the JFormForm Control
        Parameters specified in the parameters list and to initialize the *this*
        'JFormInfo', 'JFormState' and 'WorkSheet' Fields as a  function of the 'isFile'
        Status...

        Kernel Usage:
        1)      Constructor w/ 'built_In_Test Control...
        2)      Constructor w/ Built_In_Test and focus_Trace Controls...
 
        

Parameters:
inCategory - Category String
inFileName - File Name Stgring
inNC - Number of Columns on the Application Form
inNR - Number of Rowss on the Application Form
inTitle - Form Title String

JFormForm

public JFormForm(java.lang.String inCategory,
                 java.lang.String inFileName,
                 java.lang.String inNC,
                 java.lang.String inNR,
                 java.lang.String inTitle,
                 java.lang.String built_In_Test)
        Constructor that is used by the 'End User' to establish the JFormForm Control
        Parameters specified in the parameters list and to initialize the *this*
        'JFormInfo', 'JFormState' and 'WorkSheet' Fields as a function of the 'isFile'
        Status...
        

Parameters:
inCategory - Category String
inFileName - File Name Stgring
inNC - Number of Columns on the Application Form
inNR - Number of Rowss on the Application Form
inTitle - Form Title String
built_In_Test - String w 1st Char = "t" or "f" for Built-In-Test Run-Time Processing...

JFormForm

public JFormForm(java.lang.String inCategory,
                 java.lang.String inFileName,
                 java.lang.String inNC,
                 java.lang.String inNR,
                 java.lang.String inTitle,
                 java.lang.String built_In_Test,
                 java.lang.String focus_Trace)
        Constructor that is used by the 'End User' to establish the JFormForm Control
        Parameters specified in the parameters list and to initialize the *this*
        'JFormInfo', 'JFormState' and 'WorkSheet' Fields as a  function of the 'isFile'
        Status...
        

Parameters:
inCategory - Category String
inFileName - File Name Stgring
inNC - Number of Columns on the Application Form
inNR - Number of Rowss on the Application Form
inTitle - Form Title String
built_In_Test - String w 1st Char = "t" or "f" for 'jFormTK' Built-In-Test Run-Time Processing...
focus_Trace - String w 1st Char = "t" or "f" for 'jFormTK' Focus-Trace Run-Time Processing...
Method Detail

buildTableLayoutSize

public static double[][] buildTableLayoutSize(java.lang.String id,
                                              int rowHeight,
                                              int nCols)
        Build the 'size' double array that is required by the 'TableLayout' Constructor.
        This 'double' array is designed to control the Column and Row parameters of a
        'TableLayout'...
 
        Size Array Format:
        double size [][] = {
        {[colWidths...]} // Cols
        { rowHeight}};   // Rows
        

Parameters:
rowHeight - Row Height to be inserted as a function of the Number Of Rows Parameter [int]...
nCols - Number of Columns to be inserted into the 'size' Columns parameters [int]...
Returns:
Double [][] array formatted for TableLayout usage...

getAtypicalDialogControl

public java.lang.String getAtypicalDialogControl()
Returns:
'atypicalDialogControl' String...

getFieldID

public static java.lang.String getFieldID(java.lang.String anchor)
        Get the 'JFormForm' ID...

        Kernel Usage:
        'JAddressBook.AddressBookRemove.doRemoveYes' method...
        

Parameters:
anchor - 'JAddressBook' Anchor
Returns:
The 'JFormField' ID for the given JAddressBook Anchor...

getFormID

public static java.lang.String getFormID(java.lang.String anchor)
        Get the 'JFormForm' ID as a function of the given JAddressBook Anchor...
        

Parameters:
anchor - JAddressBook Anchor...
Returns:
Form ID as a function of the

isGroup

public static boolean isGroup(java.lang.String anchor)
        Return a boolean Flag to indicate if the 'JFormField' referenced by the given
        anchor is within a group...
        

Parameters:
anchor - JAddressBook Anchor...
Returns:
Flag [boolean] indication the Group Existence...

displayElements

public java.lang.String displayElements()
        Return a display string to show the Form ID for each 'JFormField' of the
        'jFormFields' Collection. Display each 'JFormField.ID' on a New line with an
        index Prefix starting with zero...

        Kernel Usage:
        1)      'JFocus.loadFormState' method when a Soft Abort is performed showing
                that the load time 'JFormField' insex is out of sync with the loaded
                'JFormFields Collection...
        

Returns:
Constructed

doButton

public java.lang.String doButton(JFormField fld,
                                 java.lang.String flowControlIn)
        This method is designed to satisfy the Java Compiler for the 'doButton' Method.
        The 'jFormTK' Developer must provide a 'doButton' Method override in their
        'JFormForm' Sub-Class whenever a "Do Button" [JFormField.type = _BField exist.
 
        If they DO NOT provide an OVERRIDE 'doButton' Method,
        Then this method is envoked by the 'jFormTK' Kernel envoked and the programmer
        is notified of the error via the "Soft Abort" 'jFormTK' Class...

        Kernel Usage:
        1)      'JFocus.doFocus' iff 'JFormField.type' == _BField...
        

Parameters:
fld - "Reference" to the current 'JFormField' instance...
flowControlIn - Input Flow Control String...
Returns:
Flow Control

doPerson

public java.lang.String doPerson(JFormField fld,
                                 java.lang.String flowControlIn)
        This method is designed to satisfy the Java Compiler for the 'doPerson' Method.
        The 'jFormTK' Developer must provide a 'doPerson' Method override in their
        'JFormForm' Sub-Class whenever a JFormField.type = _PField exist.
 
        If they DO NOT provide an OVERRIDE 'doPerson' Method,
        Then this method is envoked by the 'jFormTK' Kernel and the programmer
        is notified of the error via the "Soft Abort" 'jFormTK' Class...

        Kernel Usage:
        1)      'JFocus.doFocus' iff 'JFormField.type' == _PField...
        

Parameters:
fld - "Reference" to the current 'JFormField' instance...
flowControlIn - Input Flow Control String...
Returns:
Flow Control

doQuery

public java.lang.String doQuery(JFormField fld,
                                java.lang.String flowControlIn,
                                java.lang.String from)
        This method is designed to satisfy the Java Compiler for the 'doQuery' Method.
        The 'jFormTK' Developer must provide a 'doQuery' Method override in their
        'JFormForm' Sub-Class whenever a JFormField.type = _QField exist.
 
        If they DO NOT provide an OVERRIDE 'doQuery' Method,
        Then this method is envoked by the 'jFormTK' Kernel and the programmer
        is notified of the error via the "Soft Abort" 'jFormTK' Class...

        Kernel Usage:
        1)      'JFormField.doPostProcess' iff the post processing is active and the
                'type' = _QField...
        

Parameters:
fld - "Reference" to the current 'JFormField' instance...
flowControlIn - Input Flow Control String...
Returns:
Flow Control

equals

public boolean equals(JFormForm inForm)
        compare the current 'JFormForm' with the given 'JFormForm' and return the
        appropriate boolean Flag...

        The compare process is accomplished via the 'getID' parameter of the respective
        'JFormField' instances...
        

Parameters:
inForm - "Reference" to the 'JFormField' Sub-Class to compare to *this* 'JFormField' Sub-Class...
Returns:
Flag [boolean] based on Compare results...

getActiveFormFields

public java.util.Vector getActiveFormFields()
        Get a Vector of the Active 'formFields'.
        NOTE:
        This Vector is used to compute the 'JFocus.contiguous' control.
        Therefore it is assumed that the 'formField' Vector shall always exist
        when this method in envoked...

        Kernel Usage: 
        

Returns:
Vector with a 'JFormField' Reference for each ACTIVE field of the current 'JFormForm' Sub-Class...

getBuilt_In_TestFlag

public boolean getBuilt_In_TestFlag()
        Get the "Built_In_Test" Flag for *this* 'JFormForm' Sub-Class...
        

Returns:
Flag [boolean] to indicate current "Build-In-Test" state...

getCategory

public java.lang.String getCategory()
        Get the "Category" String for this 'JFormForm' Sub-Class. It is generally used
        when a 'JFormTK' Program needs to find an Index into the 'AppForms' instance.
        The 'Category' and 'FileName' Strings are required to find a
        specific 'jFormTK.JFormForm' instance...
        

Returns:
Category String...

forceActiveFieldBefore

public JFormField forceActiveFieldBefore(java.lang.String targetID)
        Get the "Active" JFormField at or BEFORE the given 'JFormField' ID...
        If the given 'JFormField' ID is an active Field then return it.
        Else return the first "Active" 'JFormField' BEFORE the given ID...

        Kernel Usage:
        1)      'JFocus.doPostProcess' method when looking for the last 'JFormField' of
                a Highlited Range. This unique logic is requred for the case when ALL
                "Physical" fields of a range are highlited. The return 'JFormField' is
                used to trigger the Exit Highlite Range processing...
        

Parameters:
targetID - The 'JFormField' ID for the last field in a Highlite Set...
Returns:
The 'JFormField' reference for the "Active" field...

getFileName

public java.lang.String getFileName()
        Get the "FimeName" String for this 'JFormForm' Sub-Class. It is generally used
        when a 'JFormTK' Program needs to find an Index into the 'AppForms' instance.
        The 'Category' and 'FileName' Strings are required to find a
        specific 'jFormTK.JFormForm' instance...
        

Returns:
FileName String...

getFocusTraceFlag

public boolean getFocusTraceFlag()
        Get the "Focus Trace" Flag for *this* 'JFormForm' Sub-Class...
        

Returns:
Flag [boolean] to indicate current "FocusTrace" state...

getFormFields

public java.util.Vector getFormFields(java.lang.String from)
        Get a "Reference" to the *this* 'formFields' Vector.
        If the current 'JFormField' Sub-Class has not been loaded,
        i.e. the Vector size is zero
        Then the return vector is initialized from the 'JFormField' Storage Device
        [e.g. HDD]...

        Kernel Usage:
        1)      '*this*.getGroupFields' Method to LOOP thur the 'JFormForm' Sub-Class
                for 'JFormField' instances in a specific 'jFormTK' Group...
        2)      '*this*.getJFormField' Method to get the 'JFormForm' Sub-Class fields
                to search for a given 'JFormField' ID...
        3)      '*this*.getActiveFormFields' Method to ensure that the Vector of 'JFormForm'
                Sub-Class JFormField's is NOT Null...
        4) ... n)
                Used multiple time in the 'jFormTK' Kernel whenever a search of a 'JFormForm'
                subclass is required to match a specific condition...
                To numerous to list individually [e.g. was 59 times on 5/24/2002].
        

Parameters:
from - DEBUG annotation of the calling Class/Method...
Returns:
Vector with a 'JFormField' Reference for each field of the host 'JFormForm' Sub-Class.

getHighlitedLAF

public JFormFieldLAFS getHighlitedLAF()
        Return the Highlited JLAF value...

        Kernel Usage:
        1)      'JHDD_IO.showPage' Method to determine if the 'showPanel' shall be redrawn...
        

Returns:
the 'highlitedLAF' instance...

getIFields

public java.util.Vector getIFields(int count)
        Construct a Vector of the current Forms '_IField' instances...
        Terminate the vector build process when the given 'count' instances are
        found...

        Kernel Usage:
        1)      'JFormFrame.showPanelToFormFields' Method to append the _IField instances to
                the constructed Vector of 'JFormField' instances...
        

Parameters:
count - Maximum number [int] of _IField instances expected...
Returns:
Vector of 'JFormField' instances with 'type' of _IField...

getFormInfo

public JFormInfo getFormInfo()
 Get the 'JFormField.JFormInfo' "Reference"...
 Note:
 Each 'JFormField' Sub-Class host a 'JFormInfo' instanced during the Application the initialization phase.
 

Returns:
'JFormInfo' "Reference"...

getFormState

public JFormState getFormState()
        Get the 'JFormForm.JFormState' "Reference"...
        Note:
        Each 'JFormField' Sub-Class host a 'JFormInfo' instanced during the Application the initialization phase.
        

Returns:
'JFormState' "Reference"...

getGroupFields

public java.util.Vector getGroupFields(java.lang.String groupNameIn,
                                       java.lang.String setNumberIn)
        Get a Vector of 'JFormField' "References" that match the Given Group Name
        [groupName] and Set Number [setNumberIn].
        If the given set number is "ALL",
        Then all the elements of the given Group Name are returned...
 
        NOTE:
        The _AField and _DField items associated with the given Group are NOT returned
        in the constructed Vector. 
        These 'JFormTK' Control Fields technically are NOT a part of a Group. They may OR 
        may Not have the Group Name Set...
        

Parameters:
groupNameIn - Group Name String
setNumberIn - Set Number String
Returns:
Vector with a 'JFormField' "Reference" for each 'JFormField' with the given Group / Set Number...

getGroupJFormFields

public JFormField[] getGroupJFormFields(java.lang.String groupName,
                                        int nFields,
                                        int setNumber)
        Produce and return an Array of 'JFormField' elements as a function of the
        given 'setNumber' int as follows:
                1)      setNumber >= 0
                        Return the 'JFormField' Array for the given Set Number...
                2)      setNumber < 0
                        Return the 'JFormField' Array for first 'n' sets where 'n' is
                        the absolute value of the given 'setNumber'...
                        NOTE:
                        The 'setNumber' is generally set to the negative of the current
                        number of Sets, i.e. ALL the current Sets...

        Kernel Usage:
        1)      'JFormForm.getRangeJFormFields' when a Group Name is given in a
                Highlite Controls 'range' parameter...
        

Parameters:
groupName - Group Name String...
nFields - Number of Fields [int] in a Group Set...
setNumber - Set Number Control 'int'...
Returns:
Array of constructed set of 'JFormField'...

getID

public java.lang.String getID()
        Get the 'JFormForm' Unique "ID" String for *this* 'JFormForm' Object. This id
        was produced by the *this* constructor given the 'JFormField' Sub-Class assigned
        Category, Sub=Category and File [Form] Name...
        

Returns:
'JFormForm' ID String...

getFirstActiveJFormField

public JFormField getFirstActiveJFormField()
        Return the first Active 'JFormField' of the host 'JFormForm' Sub-Class...

        Kernel Usage:
        1)      'JFormControl.doFocus' method when a new 'JFormForm' Sub-Class is referenced
                and the focus 'JFormField' is null...
        

Returns:
'JFormField' reference to the first Active 'JFormField'...

getJFormField

public JFormField getJFormField(java.lang.String inFldID)
        Get a 'JFormField' "reference for the given 'JFormField' ID String [inFldID]. 
        If the given ID is null [i.e. =""],
        Then the first "Active" 'JFormField of the 'formFields' Vector is set as the
        returned 'JFormField'...
 
        If the given ID is NOT null AND is not found in the 'formFields' Vector
        Then the return 'JFormField' is null...

        ASSUMPTION:
        The 'JFormField' ID to be found is within the currenly loaded 'JFormForm'
        Sub-Class... 
        

Parameters:
inFldID - 'JFormField' ID String
Returns:
'JFormField' "Reference" for matching ID or 'Null'

getFormFieldIDs

public java.lang.String getFormFieldIDs(java.lang.String tab)

getJFormFieldIndex

public int getJFormFieldIndex(java.lang.String fldID)
Get the Index of the given 'JFormField' ID for this 'JFormForm' Sub-Class... Note 1: The calculated index is generally the index into the 'formFields' Vector. However, if the 'formFields' Vector does not exist, then the return index is the index into the associated Work Sheet Field names... Note 2: This method is designed to determine if a given 'JFormField' ID is legal [index returned is NOT -1] and to determine where a given 'FormField' ID exist in the 'JFormForm' Sub-Class relative to another ID of the same form. For example, 'JFormInfo.getHighliteControls' method uses the index to ensure that the Start 'JFormField' occurs before the End 'JFormField' in the form... Kernel Usage: 1) 'JFormInfo.getHighliteControls' Method to verify that the given Range ID's are in a Forward Reference sequence...

Parameters:
fldID - In 'JFormField' ID to find an index for...
Returns:
Index of the given Form ID...

getLastRowAdded

public int getLastRowAdded()
        Get the "last row added" row number...
        

Returns:
Row Number [int] of the last 'JFormField' added to the 'JFormForm'

getNextFocusedJFormField

public JFormField getNextFocusedJFormField(java.lang.String currentID)
        Return the Next Active 'JFormField' following the given 'JFormField' ID String
        [currentID]. If the specified ID is the Last Active 'JFormField', then return
        the first 'JFormField' of the host 'JFormForm' Sub-Class...

        Kernel Usage:
        1)      'JFocus.doPostProcess' method to calculate a flag to indicate if a Post
                Processor has changed the normal "Flow" of a form. This indicatotr is used
                as part of the "Highlite Controls" 'jFormTK' Feature...
        2)      'JFormFrame.getContiguousIndex' method iff the given current 'JFormField' is
                NOT an "Active" 'JFormField' instance...
        

Parameters:
currentID - Reference 'JFormField' ID String...
Returns:
A 'JFormField' reference for the next 'JFormField'...

getPreviousFocusedJFormField

public JFormField getPreviousFocusedJFormField(java.lang.String currentID)
        Return the Previous Active 'JFormField' following the given 'JFormField' ID String
        [currentID]. If the specified ID is the First Active 'JFormField', then return
        the last Active 'JFormField' of the host 'JFormForm' Sub-Class...

        Kernel Usage:
        1)      TBD...
        

Parameters:
currentID - Reference 'JFormField' ID String...
Returns:
A 'JFormField' reference for the next 'JFormField'...

getNotePad

public NotePad getNotePad()
        Get a "Reference" to *this* JFormForm's 'NotePad' instance...
 
        Note:
        Each 'JFormForm' Sub-Class has a 'jFormTK.NotePad' instanced in it's
        Constructor.
        This class [NotePad] is designed to hold App End User Notes that a specific to
        the hosting 'JFormForm' Sub-Class Application Form...
        

Returns:
"Reference" to the *this* NotePad instance...

getNumberOfFields

public int getNumberOfFields()
        Return the size of the current 'JFormFields' Vector...

        Kernel Usage:
        1)      'JFormFrame.showPanelToFormFields' Method to determine if the return Vector
                of 'JFormField' instances derived from the 'showPanel' components shall be
                appended with '_IField' instances...
        

Returns:
size [int] of the current 'JFormFields' Vector

isCrypt

public boolean isCrypt()
Returns:
'crypt' Flag...

findCurrentJFormField

public int findCurrentJFormField(JFormField fld)
        Return the index for the given 'JFormField' in the current
        'JFormForm Sub-Class Form Fields Vector...

        Kernel Usage:
        1)      'JFormField.doPostProcess' method to determine if the '_QField' "No" OR
                "YES" fields already exist in the current Form Fields Vector...
        

Parameters:
fld - JFormField to be found in the Form Fields Vector...
Returns:
Index [int] of found 'JFormField' OR -1 if NOT Found...

isFlowControlMouseControl

public boolean isFlowControlMouseControl()
Returns:
'flowControlMouseControl' Flag...

isFlowControlShiftTABKeyControl

public boolean isFlowControlShiftTABKeyControl()
Returns:
'flowControlShiftTABKeyControl' Flag...

isFlowControlTABKeyControl

public boolean isFlowControlTABKeyControl()
Returns:
'flowControlTABKeyControl' Flag...

isMouseContiguousFlag

public boolean isMouseContiguousFlag()
Returns:
'flowControlMouseControl' Flag...

isPostMouseControl

public boolean isPostMouseControl()
Returns:
'postMouseControl' Flag...

isPostShiftTABKeyControl

public boolean isPostShiftTABKeyControl()
Returns:
'postShiftTABKeyControl' Flag...

isPostTABKeyControl

public boolean isPostTABKeyControl()
Returns:
'postTABKeyControl' Flag...

isPostTABSelectControl

public boolean isPostTABSelectControl()
Returns:
'postTABSelectControl' Flag...

isPreMouseControl

public boolean isPreMouseControl()
Returns:
'preMouseControl' Flag...

isPreShiftTABKeyControl

public boolean isPreShiftTABKeyControl()
Returns:
'preShiftTABKeyControl' Flag...

isPreTABKeyControl

public boolean isPreTABKeyControl()
Returns:
'preTABKeyControl' Flag...

nullFocusChangeControls

public void nullFocusChangeControls()
        This method is designed to set each of the Focus Change Controls
        to the null state, i.e. char = -1;

        Kernel Usage:
        1)      'this.init' Method...
        2)      'jFormTK' test suite classes, e.g. Cat1.Focus Class, to control the
                'JFormForm' Sub-Class parameters between test loops...
        


setAtypicalDialogControl

public void setAtypicalDialogControl(java.lang.String s)
Parameters:
s - set the Atypical Dialog Control...

setBuilt_In_TestFlag

public void setBuilt_In_TestFlag(boolean flag)
        Set the "Built_IN_Test" Flag...
        

Parameters:
flag - Flag [boolean] to set the 'built_In_TestFlag' to...

setCrypt

public void setCrypt(boolean flag)
Parameters:
flag - Flag [boolean] to set 'crypt' to...

setFlowControlMouseControl

public void setFlowControlMouseControl(boolean flag)
Parameters:
flag - Flag [boolean] to set the Control to...

setFlowControlShiftTABKeyControl

public void setFlowControlShiftTABKeyControl(boolean flag)
Parameters:
flag - Flag [boolean] to set the Control to...

setFlowControlTABKeyControl

public void setFlowControlTABKeyControl(boolean flag)
Parameters:
flag - Flag [boolean] to set the Control to...

setFocusTraceFlag

public void setFocusTraceFlag(boolean flag)
        Set the "Focus Trace" Flag...
        

Parameters:
flag - Flag [boolean] to set the 'focusTraceTestFlag' to...

setFormFields

public void setFormFields(java.util.Vector v,
                          java.lang.String from)
        Set the *this* 'formFields' Vector reference...               
        

Parameters:
v - Vector Reference for the 'JFormField' instances of *this* 'JFormForm' Sub-Class...
from - DEBUG annotation for the calling method...

setFormInfo

public void setFormInfo(JFormInfo iInfo)
        Set the local 'JFormInfo' Reference...
        

Parameters:
iInfo - 'JFormInfo' Reference to set *this* 'JFormForm' Sub-Class to.

setFormLAF

public void setFormLAF()
        This method is designed to set the Application "Look & Feel" Parameters...
 
        1)      The 'JFormTKDB.initAppLAF' Method is envoked to clear all the 'FormValue'
                elements of the 'jTK' Collections...

        Note:
        the above operation is conditional. It is executed if the
        'JFormTKDB.dynamicLookAndFeel' parameter is set. This parameter is set On by
        default. It may be set to 'false' if there shall be no unique LAF processing
        required...
 
        Kernel Usage:
        1)      'JHDD_IO.showPage' - envoked when a Show Page operation is requested for a
                new 'JFormForm'...

        NOTE:
        Removed [8/22/06] when the 'JFormFieldLAFS' Class was designed and implemented...
        


setFormState

public void setFormState(JFormState iState)
        Set the local 'JFormState' Reference
        

Parameters:
iState - 'JFormState' Reference to set *this* 'JFormForm' Sub-Class to...

setIndexBeforeHere

public CurrentFldControl setIndexBeforeHere(int currentJFormFieldIndex)
        Set the current JFormField and it's Form Fields Collection index
        to the Active Field before the current JFormField...

        Kernel Usage:
        1)      'JFocus.FocusState.getPreviousJFormField' Method...
        

Returns:
CurrentFldControl instance with the constructed JFormField / index...

setIndexFromEnd

public CurrentFldControl setIndexFromEnd()
        Set the current JFormField and it's Form Fields Collection index
        to the last Active Field...

        Kernel Usage:
        1)      'JFocus.FocusState.getLastJFormField' Method...
        2)      'JFormForm.setIndexFromHere' method when an Active 'JFormField' is
                NOT found previous to the current 'JFormField'...
        

Returns:
CurrentFldControl instance with the constructed JFormField / index...

setIndexFromHere

public CurrentFldControl setIndexFromHere(int currentJFormFieldIndex)
        Set the current JFormField and it's Form Fields Vector index
        to the next Active Field from the given 'currentJFormFieldIndex' control...

        Kernel Usage:
        1)      'JFocus.FocusState.getNextJFormField' Method to establish the next
                active 'JFormField' to be focused in the showPanel...
        

Returns:
CurrentFldControl instance with the constructed JFormField / index...

setIndexFromStart

public CurrentFldControl setIndexFromStart()
        Set the current JFormField and it's Form Fields Collection index
        to the first Active Field...

        Kernel Usage:
        1)      'JFocus.FocusState.getFirstJFormField' Method...
        2)      'JFormForm.setIndexFromHere iff an Active 'JFormField' is not found in the
                remainder of the 'JFormFields' Vector...
        

Returns:
CurrentFldControl instance with the constructed JFormField / index...

setLastRowAdded

public void setLastRowAdded(int newRow)
        Set the 'lastRowAdded' instance variable...

        Kernel Usage:
        1)      'JFormFrame.addField' method to record the row number being added...
        

Parameters:
newRow - New Last Row Added [int]

setMouseContiguousFlag

public void setMouseContiguousFlag(boolean flag)

setNotePad

public void setNotePad(NotePad inNotePad)
        Set the local 'NotePad' Redference...
        

Parameters:
inNotePad - 'NotePad' instance to be used locally...

setNumberOfNotes

public void setNumberOfNotes(int n)
        Set the 'number of Notes' local parameter...
        

Parameters:
n - Number Of Notes [int]

setPostMouseControl

public void setPostMouseControl(boolean flag)
Parameters:
flag - Flag [boolean] to set the Control to...

setPostShiftTABKeyControl

public void setPostShiftTABKeyControl(boolean flag)
Parameters:
flag - Flag [boolean] to set the Control to...

setPostTABKeyControl

public void setPostTABKeyControl(boolean flag)
Parameters:
flag - Flag [boolean] to set the Control to...

setPostTABSelectControl

public void setPostTABSelectControl(boolean flag)
Parameters:
flag - Flag [boolean] to set the Control to...

setPreMouseControl

public void setPreMouseControl(boolean flag)
Parameters:
flag - Flag [boolean] to set the Control to...

setPreShiftTABKeyControl

public void setPreShiftTABKeyControl(boolean flag)
Parameters:
flag - Flag [boolean] to set the Control to...

setPreTABKeyControl

public void setPreTABKeyControl(boolean flag)
Parameters:
flag - Flag [boolean] to set the Control to...

getNumberOfNotes

public int getNumberOfNotes()
Get the current 'number of Notes added to the associated 'NotePad' instance by the Applications End User...

Returns:
Number of 'NotePad' Notes [int]

getRange

public java.lang.String getRange(java.lang.String mode)
        Create a String that contains the Start ID and End ID separated by DASH.
        Set Start ID and End ID as a function of the 'mode' parameter when
        'mode' = the following options:

        If 'mode' = the null string
        Then set Start / End ID to the "Active" 'JFormForm' ID's
        Else if 'mode' == "All"
        Then use the physical first and last elements...

        If the load state is 'N'
        Then use the 'JWorkSheet' Class to derive the above 'range' output...

        Kernel Usage:
        1)      'Util.verifyRange' Method...
        

Parameters:
mode - Control [String] for range calculation...
Returns:
String of Start ID and End ID with DASH separator...

getScrollAdjust

public int getScrollAdjust()
Returns:
'scrollAdjust' int...

getTableLayout

public info.clearthought.layout.TableLayout getTableLayout()
        Get the current 'JFormForm' Show Panel's TabeLayout instance...

        Note:
        Each 'JFormForm' Sub-Class requires it's own 'TableLayout' instance because the
        Table Layout is a function of the 'JFormForm' Sub-Class Number of Columns and,
        as the Form is Dynamically changed, it's Number of Rows.

        Kernel Usage:
        1)      'JHDD_IO.showPage' method to get the default TableLayout layout component...
        

Returns:
This JFormField's unique TableLayout instance...

getTreePath

public javax.swing.tree.TreePath getTreePath()
Get the 'JFormTree' Path to the Title Leaf... Kernel Usage: 1) Used by 'JFormTree.expandPath' Method...

Returns:
TreePath "Reference"

getWorkSheet

public JWorkSheet getWorkSheet(java.lang.String from)
        Get the 'JFormForm.JWorkSheet' "Reference"...
        Note:
        Each 'JFormField' Sub-Class host a 'JWorkSheet' instanced during the Application
        initialization phase...

        A collection of JWorkSheet's are developed during the 'jFormTK' Application
        Development Stage...

        There shall be a JWorkSheet instance for each Application Form, i.e. each
        'JFormField' Sub-Class.

        After 'jFormTK' Application deployment the 'JWorkSheet' instance hosted by
        each 'JFormField' Sub-Class instance is used to produce Application End User
        Work Sheets and to service 'JFormField' Forward References,     i.e. enable setting
        of 'JFormField' fields in forms that have not been processed yet.

        Kernel Usage:
        1)      'AppForms.getJFormFieldActiveNames' Method when the Work Sheet File is
                the only source for 'JFormField' information for a 'JFormForm' Sub Class.
                This occurs when the form to be searched for Active 'JFormField' names has
                not been loaded yet by the 'jFormTK' Application End User...
        2)      'AppForms.getValue' Method when the Work Sheet File is the only source for
                'JFormField' information for a 'JFormForm' Sub Class. This occurs when the
                form to be searched for a 'JFormField' value has not been loaded yet
                by the 'jFormTK' Application End User...
        3)      'AppForms.isFieldName' Method when the Work Sheet File is the only source for
                'JFormField' information for a 'JFormForm' Sub Class. This occurs when the
                form to be searched for a 'JFormField' value has not been loaded yet
                by the 'jFormTK' Application End User...
        4)      'AppForms.isGroupName' Method when the Work Sheet File is the only source for
                'JFormField' information for a 'JFormForm' Sub Class. This occurs when the
                form to be searched for a 'JFormField' value has not been loaded yet
                by the 'jFormTK' Application End User...
        5)      'AppForms.setValue' Method when the form to be set for a 'JFormField' value
                has not been loaded yet by the 'jFormTK' Application End User. If the
                referenced 'JFormField' is found in the JWorkSheet' instance, then the
                given value is saved in the 'JWorkSheet' instance until the form is actually
                loaded [processed] by the 'jFormTK' Application End User...
        6)      'AppForms.getWS' Method to get a reference to the 'JWorkSheet' Instance
                hosted by a specified 'JFormForm' SubClass ID...
        7)      'BasejFormTK.Menu.actionPerformed' Method when a "DEBUG" Menu Show Work
                Sheet operation is requested...
        8)      'JHDD_IO.showPage' Method to get the current Work Sheet [JWorkSheet] for
                Shell Processing, i.e updating the Work Sheet from a recently modified
                'JFormForm' SubClass Java File...
        9)      'JValue.Constructor' when a Forward Reference is made, i.e. a Reference to a
                'JFormForm' SubClass that has not been processed yet by the 'jFormTK'
                application End User...
 10)    'Util.addField' to update the 'JWorkSheet' instance with the added
                'JFormField' fields...
 11)    'Util.getJFormField' if the referenced 'JFormForm' SubClass is not currently
                loaded. The 'JWorkSheet' is used to verify the given 'JFormField' ID before
                attempting to get a "Reference" to the field from a "Processed" 'JFormForm'
                SubClass on the HDD.
 12)    'Util.verifyFields' Method to verify 'JFormField' Names for unloaded
                'JFormForm' SubClass references...
        

Returns:
'JWorkSheet' "Reference"...

getWorkSheetFlag

public boolean getWorkSheetFlag()
        Get the JWorkSheet Flag for *this* 'JFormForm' Sub-Class...
 
        Note:
        This flag is used during the 'jFormTK' development phase to dynamically keep the
        'JWorkSheet" file up to date so that it, the 'JWorkSheet", shall always reflect
        the latest collection of JFormField's of *this* 'JFormForm' Sub-Class...

        Kernel Usage:
        1)      'Util.addField' method to add 'JFormField' references to the 'JWorkSheet'
                to keep the Work Sheet in sync...
        

Returns:
Flag [boolean] to inform if the JWorkSheet exist and is current...

verifyCurrentJFormFieldIndex

public boolean verifyCurrentJFormFieldIndex(JFormField fld,
                                            int index)
        Verify that the given 'JFormField' exist in the specified element of the
        host 'JFormForn' Sub-Class 'JFormField' Vector...

        Kernel Usage:
        1)      'JFocus.loadFormState' method to ensure that the 'JFormField' Vector is in
                sync for the 'JFormForm' Sub-Class to be loaded and focused...
        

Parameters:
fld - 'JFormField' instance to receive the Show Panel Focus...
index - The element index of the 'JFormForm' Sub-Class 'JFormField' Collection...
Returns:
A flag [boolean] based on the compare of the given 'JFormField to the cooresponging 'jFormFields' Collection...

init

public void init()
        This method is designed to satisfy the Java Compiler for the init Method.
        The 'jFormTK' Application Developer SHALL produce a 'JFormField' Sub-Class
        [override] designed for each unique unique Application Form.
        [See 'Getting Started 'init' Method Doc]
 
        If no 'JFormField' Sub-Class exist for an Application Form identified in the
        'jFormTK.AppForms' Class,
        Then this method is envoked and the 'jFormTK' Application developer is notified
        of the error via a Soft Abort...
 
        NOTE:
        This method, OR it's override instance, is envoked iff the "Saved" instance for
        the 'JFormForm' Sub-Class does NOT exist, i.e. it is used to instance the
        Application Form on one occasion and then the Form is serviced as a function of
        it's State when the form was last saved to the 'jFormTK' Application Storage
        Device...
        


postProcessor

public java.lang.String postProcessor(JFormField fld,
                                      java.lang.String flowControl)
        This method is designed to satisfy the Java Compiler for the 'postProcessor'
        Method. The 'jFormTK' Developer must provide a 'postProcessor' Method override
        in their 'JFormForm' Sub-Class whenever a "Custom Post Processor" Run-Time
        operation is required...
 
        If they DO NOT,
        Then this method is envoked by the 'jFormTK' Kernel and the programmer is
        notified of the error via the "Soft Abort" 'jFormTK' Class...
        

Parameters:
fld - "Reference" to the current 'JFormField' instance...
flowControl - Current 'flowControl' String...

preProcessor

public java.lang.String preProcessor(JFormField fld,
                                     java.lang.String flowControl)
        This method is designed to satisfy the Java Compiler for the 'preProcessor'
        Method. The 'jFormTK' Developer must provide a 'preProcessor' Method override in
        their 'JFormForm' Sub-Class whenever a "Custom Pre Processor" Run-Time operation
        is required...
 
        If they DO NOT,
        Then this method is envoked by the 'jFormTK' Kernel and the programmer 
        is notified of the error via the "Soft Abort" 'jFormTK' Utility...

        Kernel Usage:
        1)      'JFormField.doPreProcess' Method when the "To Be Focused' 'JFormField' has
                it's Pre Processor Flag active...
        2)      The 'JFormForm.SubClass.preProcessor' method using the 'super.preProcessor'
                invocation to request 'jFormTK' Kernel Processing...
        

Parameters:
fld - "Reference" to the current 'JFormField' instance...

XXXrequestFocus

public void XXXrequestFocus()
        'requestFocus' 'jFormTK' Override Method...
        

See Also:
Component.requestFocus()

setScrollAdjust

public void setScrollAdjust(int i)
Parameters:
i - 'scrollAdjust' Adjustment int...

setTreePath

public void setTreePath(javax.swing.tree.TreePath inPath)
        Set the *this* TreePath instance that is used to service the 'jFormTK.Control'
        TAB Application Forms Tree...
 
        Note:
        This 'TreePath' is created during the 'jFormTK' Kernel Initialization Process as
        a function of the various Application Forms that are described in the
        'jFormTK.AppForms' Class...

        Kernel Usage:
        1)      'AppForms.setNodes' method whild setting the 'jFormTK' Forms Tree....
        

Parameters:
inPath - Jasva 'TreePath' instance for the associated App Form...

XXXsetWorkSheetFlag

public void XXXsetWorkSheetFlag(boolean flag)
        Set the JWorkSheet Flag for *this* 'JFormForm' Sub-Class...
 
        Note:
        This flag is used during the 'jFormTK' development phase to dynamically keep
        the 'JWorkSheet" file up to date so that it, the 'JWorkSheet", shall always
        reflect the latest collection of JFormField's of *this* 'JFormForm' Sub-Class...
        

Parameters:
flag - Flag [boolean] to inform if the JWorkSheet exist and is current...

showFORM

public void showFORM()
Show the parameters of the current 'JFormForm' Sub-Class...


getHasJFormFieldHighlitedLAF

public int getHasJFormFieldHighlitedLAF()

getRangeJFormFields

public java.util.Vector getRangeJFormFields(java.lang.String range)
        Build and return a Vector of 'JFormField' elements from the current
        'JFormForm' Sub-Class as a function of the given 'range' Control. The
        'range' String is one of two formats as required by the "Highlite Controls":
                "fldID1-fldID2"         -       Range of 'JFormField' elements by JFormField ID...
                "groupName"                     -       A Group Name...
                "groupName.setNumber-   Set "setNumber" of a Group Names hosted by this
                                                                'JFormForm' Sub-Class...

        Kernel Usage:
        1)      'JFormInfo.removeHighliteSetNOW' method when a Highlite Set is to be
                removed and the Highlite Sets 'JFormFields' are to be refreshed to their
                original Look And Feel...
        

Parameters:
range - String to control the JFormField's to return...
Returns:
Vector of "Within Range" JFormField instances...

decrementHasJFormFieldHighlitedLAF

public void decrementHasJFormFieldHighlitedLAF()

incrementHasJFormFieldHighlitedLAF

public void incrementHasJFormFieldHighlitedLAF()

setHasJFormFieldHighlitedLAF

public void setHasJFormFieldHighlitedLAF(int i)