com.jFormTK
Class Util

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

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

This 'jFormTK' abstract class is a Collection of 'jFormTK' Utility Methods...

Version:
1.00, 3 May 2004
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

Field Summary
(package private) static java.lang.String assignmentString
           
(package private) static JFormField currentAssignmentObject
           
(package private) static int LOWERED
           
(package private) static int RAISED
           
 
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
Util()
           
 
Method Summary
static java.lang.String adjustSetNumber(java.lang.String refIn, java.lang.String from)
           If the given ref set number is the JFormTKDB.getSetNumberWildCard, Then reset it to the last set Number of the Group decoded from the given 'jFormTK.jFormField' Reference ID [refIn]...
static void appendBranchVerifySynopsis(java.lang.String s)
           
static java.lang.String assignment(JFormForm form, JFormField refFld, java.lang.String assignmentIN, int aType, java.lang.String flowControlIN)
           This method is designed to process the Run-Time Assignment 'jFormTK' Feature.
static java.lang.String bgcolor(java.awt.Color c)
           Return the given color [c] in HTML bgcolor Hex Format.
static boolean bitSet(int source, int bit)
           Return a boolean flag as a function of the indicated bit's setting.
static java.lang.String bitSetString(int source, int bit)
           Return a String flag annotation [i.e.
static java.lang.String booleanToString(boolean flag)
           Convert a given 'boolean' [flag] to a "T" or "F" String...
static java.lang.String buildSavedQuery(JFormField fld)
           Build and return a JFormTKDB.itemsDelimiter delimited String that contains the parameters of the given 'JFormField' that are required to reconstruct the _QField 'JFormField' of a 'jFormTK' Kernel "Group Set".
static java.lang.String buildStyledMessage(java.lang.String m)
           Build a new Message string with "Style" parameters iff the 'AppDB.JMessagePhrase' object is NOT Null.
static java.lang.String buildStyledPrompt(java.lang.String p)
           Build a new Prompt string with "Style" parameters iff the 'AppDB.JPromptPhrase' object is NOT Null...
static java.lang.String charToString(char c)
           
static boolean check_QField(JFormField fld)
           Return a boolean flag as a function of the given 'JFormField' [fld] Type [==_QField], the current _QField Value [Yes OR No] and the associated Hint Text "Yes" OR "No" existence, e.g.
static boolean checkBit(int source, int bit)
           
static int clearBit(int source, int bit)
           
static boolean compareNames(java.lang.String text, java.lang.String addressBook)
           
static void concatenateVectors(java.util.Vector vA, java.util.Vector vB)
           
static byte control(java.lang.String s)
           Return the 'byte' Control Kernel Usage: 1) 'JFormField.[5]' Constructor to convert the saved Focus Change Controls from the String Array elements to the byte control...
static java.lang.String convertMonthsYears(java.lang.String base, java.lang.String inNext)
           
static java.lang.String convertName(java.lang.String name)
           
static java.lang.String convertName(java.lang.String nameIn, java.lang.String type)
           
static int countFormFields(JFormForm form, java.lang.String name)
           Compute the number of JFormField's in the JFormForm Fields Vector [formFields] with the specified LABEL Field Name [fldName]...
static int countNumberOfGivenCharacter(java.lang.String s, char c)
           Return a count [int] of the number of characters [c] in the given String [s]...
static int dateDifference(java.util.Date first, java.util.Date last)
           
static int dateDifference(java.lang.String first, java.lang.String last)
           
static int daysFromNow(java.util.Date date)
           
static int daysFromNow(java.lang.String date)
           
static java.awt.Color decodeColor(java.lang.String encodedColorIn)
           Produce a Color Java component as a function of the given "Encoded Color" String...
static java.awt.Font decodeFont(java.lang.String encodedFontIn, java.awt.Font defaultFont, java.lang.String from)
           Produce a Font Java component as a function of the given "Encoded Font" String...
static void decrementRowNumbers(JFormForm form, int foundObjectIndex, int removedRow)
           
static void decrementRowNumbers(JFormForm form, int foundObjectIndex, int removedRow, int delta)
           
static void displayFormFields(JFormForm form, java.lang.String from)
           
static java.lang.String displayHexArray(java.lang.String heading, byte[] b)
           Convert the given Array of bytes [b] to a String [display] in a Hex Format.
static java.lang.String displayStringArray(java.lang.String heading, java.lang.String[] array)
           
static void displayUnexpectedDoCaseWarning(JFormForm form, JFormField fld, java.lang.String module)
           Display a Warning message when the 'default' branch of a Do Case [switch] is encountered...
static java.lang.String displayUtilDynamicMethods()
           
static java.lang.String displayVectorToString(java.lang.String annotation, java.util.Vector v, java.lang.String prefix, int nTruncate)
           
static void doAbort(javax.swing.JPanel panel, java.lang.String from)
           
static void doAbort(javax.swing.JPanel panel, java.lang.String from, boolean abort)
           
static void doAbort(java.lang.String from)
           
static java.lang.String doIfAssignment(JFormForm form, JFormField fld, java.lang.String ifType, java.lang.String flowControlIn, java.lang.String from)
           Perform the given Run Time 'If' assignment as a function of the given processor type [ifType], that is ifType = "pre" OR "post" IF Assignement...
static java.lang.String ensureLastCharacter(java.lang.String sIN, java.lang.String del, java.lang.String from)
           Ensure that the last character in the given String [sIN] is equal to the given delimiter [del].
static java.lang.String ensureSetNumber(java.lang.String sIN)
           
static java.lang.String fillString(boolean flag, java.lang.String fill, int n)
           
static java.lang.String fillString(int in, java.lang.String fill, int length)
           
static java.lang.String fillString(java.lang.String s, char c, int n)
           RIGHT fill the given String [s] with the given 'char' [c] to a given total length [n]...
static java.lang.String fillString(java.lang.String sIn, java.lang.String fill, int n)
           Add the given Fill String [fill] to the end of the given String [sIn] till the adjusted String is a given number of characters [length]...
static int findFieldName(java.util.Vector fieldNames, java.lang.String inFieldName)
           
static int findJFormFieldIndex(JFormForm form, java.lang.String inID)
           Return the formFields Vector index for the given 'JFormField' ID...
static int findStringArrayElement(java.lang.String element, java.lang.String[] array)
           
static JFormField firstActiveJFormField(JFormForm form)
           Find the first "Active" 'JFormField' of the given JFormForm's [formFields] Vector...
static java.lang.String firstHalfString(java.lang.String inS)
           
static java.lang.String floatToAmount(float fAmount)
           
static java.lang.String floatToString(float fAmount)
           
static int getAD(java.lang.String in)
           
static java.lang.String getAnchor(JFormForm form, JFormField jFld)
           Construct the 'JAddressBook' unique "Anchor" from the given 'JFormField' parameters.
static java.lang.String getAnchor(java.lang.String category, java.lang.String fileName, java.lang.String inGroupName, java.lang.String fieldName, java.lang.String setNumber)
           Construct the 'JAddressBook' unique "Anchor" from the given 'JFormField' parameters.
static javax.swing.border.Border getBorder(int borderControl, java.awt.Color lineBorderColor)
           
static javax.swing.border.Border getBorder(JLAF laf)
           
static java.lang.String getBreakpointAnnotation(int breakpoint)
           
static java.lang.String getChoiceDate(java.lang.String choiceField)
           
static java.lang.String getChoiceDate(java.lang.String choiceField, java.lang.String associatedValues)
           
static java.lang.String getChoiceNumber(java.lang.String choiceField)
           
static java.lang.String getChoiceNumber(java.lang.String choiceField, java.lang.String associatedValues)
           
static java.lang.String getChoiceSelection(java.lang.String choiceField)
           
static java.lang.String getColor(java.awt.Color c)
           
static java.lang.String getColorEncoded(java.awt.Color c)
           Produce a String the contains the "red", "green" and "blue" components of a Color Object with the "/" Delimiter and the "c" prefix.
static java.lang.String getColorEncodedHEX(java.awt.Color c)
           Produce a String the contains the "red", "green" and "blue" components of a Color Object with the "/" Delimiter and the "c" prefix.
static java.lang.String getColorForFont(java.awt.Color c)
           Produce a String the contains the "red", "green" and "blue" components of a Color Object with the "/" Delimiter and NO "c" prefix.
static JFormField getCurrentAssignmentField()
           
static JFormField getCurrentField()
          DEBUG method to get the 'JFormField' for the current 'JFormField...
static java.lang.String getCurrentFormID()
          DEBUG method to get the 'JFormForm' ID for the current 'JFormForm' SubClass...
static java.lang.String getCurrentJFormFieldID()
          DEBUG method to get the ID for the current 'JFormID.JFormField...
static java.lang.String getDateString()
           Get the System Date and convert it to a 'jFormTK' Standard String Format as follows: "MM/d/yyyy hh:mm:ss aa" for example: "01/28/2000 09:19:12 AM" Kernel Usage: 1) Called by the jFormTK 'JFormInfo' Constructor when creating the initial Class Instance date Strings...
static java.lang.String getDateTime()
           Return the current Date and Time information from the Platform's System Clock in the following format: "mmddyyyyhhmmss".
static int getDays(java.lang.String day1, java.lang.String day2)
           
static int getDaysCount(java.util.Date earlier, java.util.Date later)
          the difference in days between 2 dates within the Gregorian calendar - after 1582
static int getDaysFromToday(java.lang.String day)
           
static int getDisplayLines(java.lang.String s, int nCharPerLine)
           Compute the approximate number of didplay lines in the given [s] String.
static int getDoCase(char name, char[] objects)
           Return the 'int' for the item of the given 'char' [name] in the given char Array [objects].
static int getDoCase(java.lang.String name, java.lang.String[] objects)
           Return the 'int' for the item of the given String [name] in the given String Array [objects].
static java.lang.String getDynamicReferences(java.lang.String s)
           Unpack each 'jFormTK' Dynamic Reference of the given String [s] and pack the references into the return String using the 'JFormTKDB.itemsDelimiter'...
static java.lang.String getDynamicReferences(java.lang.String sIn, java.lang.String del)
           Unpack each 'jFormTK' Dynamic Reference of the given String [s] and pack the references into the return String using the given Delimiter [del]...
static java.lang.String getElementDelimiter(int parentNestingLevel)
           Get the 'elementDelimiter' =F[int parentNestingLevel].
static java.lang.String getElementDelimiter(JFormField fld)
           Return the 'element' Delimiter for the given 'JFormField' [fld] =F[JFormTKDB.elemetDelimiter] Array...
static java.lang.String getFieldByIndex(java.lang.String fieldsString, int number)
           
static java.lang.String getFieldNamefromAnchor(java.lang.String anchor)
           
static java.util.Vector getFieldNames(JFormForm form)
           
static java.lang.String[] getFields(java.lang.String sIN, java.lang.String from)
           Method to unpack the fields of the given String and place the fields into the elements of the return String Array...
static java.lang.String getFieldsDelimiter(int parentNestingLevel)
           Get the 'fieldsDelimiter' =F[int parentNestingLevel].
static java.lang.String getFieldsDelimiter(JFormField fld)
           Return the 'fields' Delimiter for the given 'JFormField' [fld] =F[JFormTKDB.fieldsDelimiter] Array...
static java.lang.String getFirstWord(java.lang.String inString)
           Return the first word of the given String.
static java.lang.String getFont(java.awt.Font f)
           
static java.lang.String getFontEncoded(java.awt.Font f, boolean bold, boolean italic, boolean underline, java.lang.String from)
           
static java.lang.String getFormula(java.lang.String formulaIN)
           
static java.lang.String[] getFormulas(java.lang.String formulaIN)
           
static java.util.Vector getGroupParametersVector(JFormForm form, java.lang.String inGroupName)
           
static int getIndex(java.lang.String[] sArray, java.lang.String valueIn)
           Return the index into the given String Array [sArray] for the given String value [valueIn].
static java.lang.String getItemsString(double[] items)
           Translate an Array of 'double' items into a single String using the D_ITEMS...
static java.lang.String getItemsString(java.lang.String[] items)
           Translate an Array of 'String' items into a single String using the D_ITEMS...
static JFormField getJFormField(JFormForm form, int row, int col)
           
static JFormField getJFormField(JFormForm form, JFormField currentFld, java.lang.String fieldName)
           
static JFormField getJFormField(JFormForm form, java.lang.String fldID, java.lang.String from)
           Get a "Reference" to a specific 'JFormField' from the given JFormForm [form], and the 'JFormField' ID...
static JFormField getJFormField(JFormForm form, java.lang.String groupNameIn, java.lang.String fieldNameIn, java.lang.String setNumber)
           This method is designed to Get a "Reference" to a specific 'JFormField' from the given JFormForm [form] , 'Group Name' [GroupName], 'Field Name' [FieldName] and 'Set Number' [SetNumber]...
static JFormField getJFormField(java.lang.String formIDIn)
           Get a reference to the 'JFormField' specified by the given "Full" 'jFormYK' ID [formIDIn].
static JFormField getJFormField(java.lang.String fieldName, JFormForm form)
           Get a "Reference" to a specific 'JFormField' from the given Field Name [fieldName] of the specified 'JFormForm' [form].
static JFormField getJFormField(java.util.Vector jFormFields, java.lang.String formIDIN)
           Get a "Reference" to a specific 'JFormField' from the given Field ID [fieldNameIDIN] of the specified 'JFormForm' [form]...
static int getJFormFieldIndex(JFormField fld, java.util.Vector jFormFields)
           Return the index into the given 'JFormFields' Vector for the specified 'JFormField' instance...
static int getJFormFieldIndex(JFormForm form, JFormField fld)
           Return the index into the given 'JFormForm.Dub-Class' jFormFields Vector for the specified 'JFormField' instance...
static java.lang.String getJFormFieldTrace(JFormField fld)
           Construct and return a String to be used in the 'Focus Trace' feature.
static java.lang.String getJLAFEncoded(JLAF laf)
           
static java.lang.String getJMessageTopic(java.lang.String messageIn)
           Return a String with each 'AppDB.JMessageTopic' instance Reference [i.e.
static java.lang.String getLabelName(java.awt.Label label)
           
static java.lang.String getLastCharacter(java.lang.String s)
           Return the last character in the given String [s]...
static java.lang.String getLastName(java.lang.String in)
           
static java.lang.String getLastName(java.lang.String in, java.lang.String del)
           
static int getLastRow(JFormForm form)
           
static java.lang.String getLastWord(java.lang.String inString, java.lang.String del)
           Return the last field [String] of the given String [inString] following the last Delimiter [del]...
static java.lang.String[] getNameString(JFormField fld, java.lang.String from)
           Return a String Array that contains the following elements: [0] - First Name; [1] - Middle Name; [2] - Last Name; [3] - suffix [e.g.
static java.lang.String[] getNameString(java.lang.String nameString, java.lang.String from)
           Return a String Array that contains the following elements: [0] - First Name; [1] - Middle Name; [2] - Last Name; [3] - suffix [e.g.
static int getNumberOfFields(java.lang.String s, java.lang.String del)
           
static int getNumberOfWords(java.lang.String sIN)
           
static java.lang.String getPostTrace(JFormField fld)
           Construct and return a String to be used in the 'Focus Trace' feature.
static java.lang.String getPreTrace(JFormField fld)
           Construct and return a String to be used in the 'Focus Trace' feature.
static JFormField getPreviousActiveJFormField(JFormForm form, JFormField fld)
           
static java.lang.String getRangeValue(java.lang.String line, char rangeOpen, char rangeClose)
           
static javax.swing.JScrollBar getScrollBar(javax.swing.JScrollPane sp, java.awt.Color background, java.awt.Color foreground, char mode, char cColor)
           Get the 'mode' JScrollBar from the given JScrollPane and set the LAF as a function of the given background / foreground Colors.
static java.lang.String getSerialNumber(java.lang.String State)
           
static int getSplitIndex(java.lang.String s, int nCharPerLine, int lastLineNumber)
           Given a String [s] that is know to be to large for it's Swing Component display [via the JPDF], the estimated number of characters per display line [int nCharPerLine] and the last display line number [int lastLineNumber] that will fit on a JPDF page compute an index [int i] to be used to split the given string for satisfactory printer display...
static int getStateCodeIndex(java.lang.String stateCode)
           
static java.lang.String[] getStateCodes()
           
static java.lang.String getStateName(java.lang.String StateCode)
           
static int getStateNameIndex(java.lang.String StateName)
           
static java.lang.String[] getStateNames()
           
static java.lang.String getSubFolderPath(java.lang.String formID)
           Build an path name with the platform separator string in lieu of the Form ID DOT character.
static int getTABIndex(java.lang.String tabName, java.lang.String[] names)
           Search the given names array [names] for the 'indexOf' occurrence of the given TAB Name [tabName].
static java.lang.String getTimeStamp()
           
static int getTitledBorder(java.lang.String type)
           Return the BorderFactory.titledBorder Justifiation = f(typeIn)...
static java.lang.String getTodaysDate()
           
static char getTypeFromString(java.lang.String stringType)
           Given the String form of a 'jFormTK' Type Constant [see JConstants Class] return the associated 'char' value.
static long getUTC(java.lang.String sDateIn)
           
static UtilValue getUtilityValue(JFormForm form, java.lang.String source, java.lang.String from)
           Reference a 'this' Utility Method using the Run Time Assignment prefix ['']...
static java.lang.Integer getVectorCount(java.util.Vector v, java.lang.String search)
           Get a count of the number of Vector Elements [v] that contain the given String [search].
static java.util.Vector getVectorSubSet(java.util.Vector v, int iStart, int iEnd)
           
static java.lang.String getVerifyFormID(java.lang.String anchor)
           
static java.lang.String getWithinBrackets(java.lang.String s)
           Return the String found within the "[]" brackes...
static java.lang.String idThis(JFormForm form, JFormField fld, java.lang.String inputID)
           
static java.lang.String intToBinary(int iValue)
           
static boolean intToboolean(int iValue)
           
static java.lang.String intToOctal(int iValue)
           
static java.lang.String intToString(int iValue)
           
static boolean isActiveField(char type)
           Return a boolean Flag if the given 'jFormField' Type is an 'Active Field'...
static boolean isActiveField(JFormField fld)
           Return a boolean Flag if the given 'jFormField' Type is an 'Active Field'...
static boolean isButton(char type)
           Return a boolean True if the given 'jFormField' Type is a _BField, _AField OR _DField...
static java.lang.String isDate(java.lang.String in)
           
static boolean isNumeric(java.lang.String in)
           determine if the given String [in] is a numeric field, i.e.
static boolean isOdd(int i)
           
static boolean isStringArrayElement(java.lang.String searchIN, java.lang.String[] array)
           Return a boolean flag of truue iff the given search String [searchIn] is found in the given String Array [array]...
static int isStringArrayIndex(java.lang.String searchIN, java.lang.String[] array)
           Return an 'int' index of the element of the String Array [array] that matches the given Search String [searchIn].
static boolean isSuffix(java.lang.String inString)
           
static java.lang.String keyToString(int key)
           
static java.lang.String lastNameFirst(java.lang.String in)
           
static void loadDocument(java.lang.String text, javax.swing.text.Document doc, javax.swing.text.SimpleAttributeSet attrs, java.awt.Color color, boolean bold, boolean underline, boolean italics, int fontSize, java.lang.String from)
           Set the "Document" Parameters for the given Sting and load it into the given "Document" Object [doc]...
static void loadJCouple(java.lang.String[] elements, java.lang.String[] values)
           
static void loadJCouple(java.lang.String elementsIn, java.lang.String valuesIn)
           This 'Util' method is designed to service a colleection of "Ordered Pairs" designed to set parameters of the current 'JCouple' instance.
static java.lang.String makeFieldPair(java.awt.Label label, java.awt.TextField text)
           
static java.lang.String makeProperName(java.lang.String sIn)
           Capitalize the given name and set the remainder of the given name to lower xase.
static java.lang.String makeSerialNumber(java.lang.String type, java.lang.String state, int nextNumber)
           
static int numberOf(java.lang.String in, java.lang.String inValue)
           
static java.lang.String objectToString(java.lang.Object variant)
           
static java.lang.String packCircularArray(java.lang.String[] lastText, int lastTextIndex, int revertBufferSize)
           Create the 'DynamicReferencingRever' "Save" string.
static java.lang.String packField(java.lang.String sIn, char c, int numberOfCharacters)
           Pack addition character ['c' ]to ensure that the output is 'NumberOfCharacters' long...
static java.lang.String packField(java.lang.String sIn, int numberOfCharacters)
           Pack addition '#' characters to ensure that the output is 'NumberOfCharacters' long...
static java.lang.String packFields(java.util.ArrayList<java.lang.String> aList)
           
static java.lang.String packFields(java.util.ArrayList<java.lang.String> aList, java.lang.String del)
           
static java.lang.String packFields(java.lang.String[] v)
           
static java.lang.String packFields(java.lang.String[] v, java.lang.String del)
           
static java.lang.String packFields(java.util.Vector v)
           
static java.lang.String packFields(java.util.Vector v, java.lang.String del)
           
static java.lang.String packItems(java.util.ArrayList<java.lang.String> aList)
           
static java.lang.String packStringVectorToString(java.util.Vector v)
           
static java.lang.String packStringVectorToString(java.util.Vector v, java.lang.String del)
           
static java.lang.String padString(boolean flag, java.lang.String fill, int n)
           
static java.lang.String padString(int in, java.lang.String fill, int n)
           
static java.lang.String padString(java.lang.String sIn, java.lang.String fill, int n)
           
static java.util.Vector parse(java.lang.String s, java.lang.String delimiter)
           Parse a given Sting' [s] into a Vector...
static java.lang.String[] parseAssignment(java.lang.String inS, JFormField fld)
           Parse the given Assignment String [inS] and verify that the individual Assignment parameters are formatted properly...
static java.lang.String[] parseCondition(java.lang.String inS, JFormField sourceFld, java.lang.String from)
           Parse the Conditional part of a 'jFormTK' Run Time Assignement operation...
static void prefixBranchVerifySynopsis(java.lang.String s)
           
static java.lang.String prefixToEncodedStringArray(java.lang.String encodedString, java.lang.String item)
           "prefix" the given encoded String Array with the given 'item' iff the given item is not found in the encoded String Array...
static void removeAppCommonDBElement(java.lang.String inName)
           
static java.lang.String removeCharacter(java.lang.String in, char c)
           
static java.lang.String removeCommas(java.lang.String in)
           
static java.lang.String removeField(java.lang.String sIN, java.lang.String field)
           Remove the given String [field] from the given String Input [SIN].
static java.lang.String removeField(java.lang.String sIN, java.lang.String field, java.lang.String D_FIELDS)
           Remove the given String [field] from the given String Input [SIN]...
static void removeHighliteSet(java.lang.String formID, java.lang.String set)
           Remove the specified "HighLite Set" from the indicated 'JFormForm' Sub-Class Form...
static void removeHighliteSet(java.lang.String formID, java.lang.String set, java.lang.String from)
           Remove the specified "HighLite Set" from the indicated 'JFormForm' Sub-Class Form...
static void removeJFormField(JFormForm form, java.lang.String id)
           Remove the JFormField [name] from the given 'JFormForm'...
static void removeJFormFields(JFormForm form, java.lang.String[] ids)
           Remove the JFormField's [Names] from the given 'JFormForm'...
static java.lang.String removePercent(java.lang.String in)
           
static java.lang.String removeSetNumber(java.lang.String idIn)
           
static java.lang.String removeWhiteSpace(java.lang.String in)
           Remove space characters [white space] from the given String [in]...
static java.lang.String replaceBrackets(java.lang.String line, java.lang.String brackets, java.lang.String replacement, int number, java.lang.String type)
          Replace text found within a set of brackets.
static java.lang.String replaceInRange(java.lang.String line, char rangeOpen, char rangeClose, char from, char to)
           Replace a 'char' found within the specifies Range char's.
static java.lang.String replaceString(java.lang.String sourceIn, int offset, java.lang.String fromIn, java.lang.String toIn)
           Replace the indicated sub-String [fromIn] with the given sub-String [toIn] starting at the specified index [offset] in the given source String [sourceIn].
static java.lang.String replaceString(java.lang.String sourceIn, java.lang.String fromIn, java.lang.String toIn, boolean all)
           Replace the indicated sub-String [fromIn] with the given sub-String [toIn] in the given source String [sourceIn].
static void resetRows(JFormForm form)
           Reset the Row numbers in the given forms [form] 'formFields' Vector as a function of the 'JFormField' 'newRow' and 'numberOfRows' parameters...
static java.lang.String reviseString(java.lang.String inString, java.lang.String preString, java.lang.String postString)
           
static java.lang.String secondHalfString(java.lang.String inS)
           
static void sequenceSetNumbers(JFormForm form, java.lang.String groupName)
           
static void set_AFieldGroupReference(JFormField fld, java.util.Vector formFields)
           This method is designed to add 'savedJFormField' Strings to the given 'JFormField' [fld] 'reference' parameter for usage when ALL the 'Group" fields have been removed and only the _AField button exist...
static void setAssignment(java.lang.String s)
           
static int setBit(int source, int bit)
           
static java.awt.Color setColor(java.lang.String inColors)
           Convert a String computed by the 'Util.getColor' Method to a Java Color Object...
static void setCurrentAssignmentField(JFormField obj)
           
static void setCurrentField(JFormField fld, java.lang.String from)
           Set the Current 'JFormField' of the Current 'JFormForm' Sub-Class...
static java.awt.Font setFont(java.lang.String inFonts)
           
static java.awt.Font setFontEncoded(java.lang.String encodedFont, java.lang.String from)
           Produce a Font object as a function of the given "Encoded Font" String in the following Format: "fnn~ss~ll~" where 'nn' represent the Font's Name, 'ss' is the Font Style Control Strings and 'll' is a String that contains the Font Size.
static void setFormLAF()
           Reset the current Form's Look and Feel Parameters as a function of the current 'JFormTKDB' Collection Elements.
static void setHighliteLAF(java.lang.String formID, java.lang.String setName, java.lang.String encodedJFormFieldLAF, java.lang.String rangeIn, java.lang.String processControl, java.lang.String exitFlowControlIn, java.lang.String exitProcessingControl, java.lang.String from)
           Set the 'highliteControls' for the 'JFormForm' Sub-Class specified in the given 'range' parameter as defined by the 'setName', 'lafs' and 'range' parameters...
static void setJFormFieldMark(JFormForm form, JFormField refField)
           Set the given Field [refObj] of the specified Form [form] as a "Marked" Field for "QuickEdit" availability...
static java.lang.String setSetNumberWildCard(java.lang.String id)
           Set the Set Number field of a given 'jFormTK' Form ID to the 'jFormTK' Set Number Wild Card...
static void setStyle(javax.swing.JTextPane tp, java.lang.String annotation)
           Set the Style Parameters of the given 'JTextPane' [tp] as a function of the given message [annotation] and the 'AppDB.JMessagePhrase' parameters.
static void setStyle(javax.swing.JTextPane tp, java.lang.String annotation, JLAF messageLAF)
           Set the Style Parameters of the given 'JTextPane' [tp] as a function of the given message [annotation] and the 'AppDB.JMessagePhrase' parameters.
static void setStyle(javax.swing.JTextPane tp, java.lang.String annotation, JLAF messageLAF, JLAF messagePhraseLAF)
           Set the Style Parameters of the given 'JTextPane' [tp] as a function of the given message [annotation] and the 'AppDB.JMessagePhrase' parameters.
static void setText(java.lang.String anchor, java.lang.String text, java.lang.String from)
           Set the 'JFormField' Text Value indicated by the given 'jFormTK' anchor to the provided [text] String...
static void show(java.lang.String message, java.lang.String type, java.lang.String from)
           This is a general purpose 'show' display method designed for usage with the 'JProperties' dynamic debug capability.
static void showFocus(java.lang.String annotation)
          This method is designed to show in the Java Console [via System.out.println] the current Focused Window Name and the Focus Owner Name.
static void showFormFields(JFormForm form, java.lang.String from)
           
static void showFormFields(JFormForm form, java.lang.String from, boolean debug)
           
static void showFormFields(JFormForm form, java.util.Vector formFields, java.lang.String from)
           
static void showFormFields(JFormForm form, java.util.Vector formFields, java.lang.String from, boolean debug)
           
static void showIntArray(java.lang.String heading, int[] array)
           
static void showStringArray(java.lang.String heading, java.lang.String[] array)
           
static void showStringVector(java.lang.String heading, java.util.Vector v)
           
static void showThread(java.lang.String prefix)
           
static void showThreadName(java.lang.String prefix)
           
static void showVector(java.lang.String annotation, java.util.Vector v, java.lang.String prefix, int nTruncate)
           
static void softAbort(java.lang.String location, java.lang.String summary)
           Use the 'JSoftAbort' Class to display a "Fatal" Error Message to the 'jFormTK' Developer...
static java.lang.String stringArrayToString(java.lang.String[] array, java.lang.String del)
           
static java.lang.String stringToAmount(java.lang.String in)
           
static boolean stringToboolean(java.lang.String in)
           
static char stringToChar(java.lang.String in)
           
static float stringTofloat(JFormField fld)
           
static float stringTofloat(java.lang.String in)
           
static int stringToInt(JFormField fld)
           
static int stringToInt(java.lang.String in)
           
static java.lang.String stripQuotesString(java.lang.String sIn)
           
static java.lang.String suffixToEncodedStringArray(java.lang.String encodedString, java.lang.String item)
           Add to the given encoded String [encodedString] the given 'item' [item] iff the given item is not found in the encoded String Array...
static java.lang.String syncSetNumber(java.lang.String inID, int setNumber)
           
static java.lang.String toCaps(java.lang.String s)
           
static java.lang.String[] toCaps(java.lang.String[] strings)
           Convert each element of the given String Array to a capital letter followed by all lowercase characters...
static java.lang.String toItemsDelimiterString(java.lang.String s, java.lang.String del)
           Convert the given String of items [s] with the given delimiter [del] to a String of items with the 'jFormTKDB' Items Delimiter...
static java.lang.String twoDigits(int in)
           Ensure that the given 'int' [in] consist of two digits.
static java.lang.String[] unpackFieldName(java.lang.String fieldName)
           
static java.util.Vector unpackFields(java.lang.String sIN)
           
static java.util.Vector unpackFields(java.lang.String sIN, java.lang.String del)
           
static java.lang.String[] unpackFormName(java.lang.String formName)
           
static java.lang.String[] unpackInsertFields(java.lang.String sIn, java.lang.String fDel)
           Unpack the last 6 String fields of the given 'savedDynamicFieldControls' String and return them in a String array.
static java.lang.String[] unpackKeyWords(java.lang.String keyWords, boolean debug)
           Unpack the given Key Words String [keyWords] into a String Array implementing the following Syntax rules: 1) Key words are delimited with the space character.
static java.lang.String[] unpackQuotePhrases(java.lang.String s)
           
static int[] unpackToIntArray(java.lang.String sIN)
           
static int[] unpackToIntArray(java.lang.String sIN, java.lang.String del)
           
static java.lang.String[] unpackToStringArray(java.lang.String sIN)
           
static java.lang.String[] unpackToStringArray(java.lang.String sIN, java.lang.String del)
           
static java.lang.String[] unpackToStringArray(java.lang.String sIN, java.lang.String del, java.lang.String from)
           Unpack the given String [sIN] using the given token Delimiter [del].
static java.lang.String[] unpackVerifyFormID(java.lang.String anchor, java.lang.String from)
           
static java.lang.String[] unpackVerifyID(java.lang.String id, java.lang.String from)
           Construct a String array that contains the following elements from the given 'jFormTK' ID String: [0] - Category [1] - FileName [2] - Group Name [3] - Field Name [4] - Set Number Note: If a field is NOT verified, Then leave the associated return String element equal to a null, i.e.
static int[] vectorToIntArray(java.util.Vector v)
           
static java.lang.Object[] vectorToObjectArray(java.util.Vector v)
           
static java.lang.String[] vectorToStringArray(java.util.Vector v)
           
static void verifyBranch(java.lang.String hostJFormFieldID, java.lang.String branchJFormFieldID)
           
static java.lang.String XXXannotation(java.awt.Component c, int displayLength)
           
static void XXXdelay(int seconds)
           LOOP [delay] within this method for the number of seconds specified by the End User.
static java.lang.String[] XXXgetFields(java.lang.String sIN, java.lang.String del, java.lang.String from)
           See Above JavaDoc for method description.
static int XXXgetJFormFieldIndex(JFormForm form, int row)
           Method to compute the formFields Vector index for the given Row.
static JFormInfo XXXgetjFormInfo()
           
static int XXXincrementRows(int iStart, int iDelta, JFormForm form)
           
static void XXXmessage(java.lang.String title, java.lang.String message, java.lang.String fieldID, boolean styleMessage)
           Display the given message in a 'JMessage' Class dialog.
static void XXXputjFormFrame(JFormFrame f)
           
static java.lang.String[] XXXunpackVerifyFieldName(java.lang.String fieldName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOWERED

static final int LOWERED
See Also:
Constant Field Values

RAISED

static final int RAISED
See Also:
Constant Field Values

assignmentString

static java.lang.String assignmentString

currentAssignmentObject

static JFormField currentAssignmentObject
Constructor Detail

Util

public Util()
Method Detail

adjustSetNumber

public static java.lang.String adjustSetNumber(java.lang.String refIn,
                                               java.lang.String from)
        If the given ref set number is the JFormTKDB.getSetNumberWildCard,
        Then    reset it to the last set Number of the Group decoded from
        the given 'jFormTK.jFormField' Reference ID [refIn]...

        Kernel Usage:
        1)      'JValue.Constructor' when a 'jFormTK.JFormField' Reference is processed...
        2)      'JValue.Constructor' when a "" prefix is serviced...
        3)      '*this*.idThis' iff a Group with 'jFormTKDB.setNumberWildCard' is found in
                the source String...
        

Parameters:
refIn - The 'JFormField' ID to be adjusted iff the Set Number Wild Card is present....
from - The method name where this method was envoked...
Returns:
The Reference ID with the adjusted 'setNumber' parameter...

XXXannotation

public static java.lang.String XXXannotation(java.awt.Component c,
                                             int displayLength)

assignment

public static java.lang.String assignment(JFormForm form,
                                          JFormField refFld,
                                          java.lang.String assignmentIN,
                                          int aType,
                                          java.lang.String flowControlIN)
        This method is designed to process the Run-Time Assignment 'jFormTK' Feature.
        Generally this feature is required to perform a simple arithmetic operation
        and store the arithmetic result in a 'JFormField' text field.
 
        [See 'Run Time: Pre / Post Assignment Processing]

        This fearure SHALL also be used to set 'jFormTK' Conditional OR unconditional
        "Branch" operations...
 
        Kernel NOTE:
        The 'jFormTK' Kernel is designed to perform Pre / Post Focus Run Time
        processing. This processing SHALL be performed in accordance with a set
        of "Control Parameters" of the 'JFormField' instance that is about to receive
        focus [Pre Processing] or loose focus [Post Processing]...
 
        These processing operations may be defined via developers Java methods that 
        override the 'JFormForm' super class 'preProcessor' / 'postProcessor' methods
        or via special 'jFormTK' "features" designed to eliminate the need for Java
        coding...
 
        The Run Time Assignment parameters that are set by this 'assignement' method 
        are used to implement the 'jFormTK' 'assignment' "feature".
 
        The 'Assignment Type' is used to fetch the 'Recurrence' Flag and 
        to Clear the Assignment String when the 'Recurrence' Flag is False...
 
        'aType' = 0 = Pre  Processor Unconditional Assignment...
        'aType' = 1 = Post Processor Unconditional Assignment...
        'aType' = 2 = Pre  If   conditional Assignment...
        'aType' = 3 = Pre  Else conditional Assignment...
        'aType' = 4 = Post If   conditional Assignment...
        'aType' = 5 = Post Else conditional Assignment...
 
        Kernel Usage:
        1)      Used by 'JFocus.preProcess' to process a Pre Process
                'Assignment' request...
        2)      Used by 'JFocus.doPostProcess' to process a Post Process
                'Assignment' request...
        3)      '*this*.doIfAssignment' Method to process the 'preIf',
                'postIf', 'preElse' and 'postElse' request...
 
        Developer Usage:
        This method may be called directly in a 'JFormForm' subclass but an assignment 
        String is generally provided via the following set of "Assignment" methods
        of the 'JFormField' 'jFormTK' Class...
                setPreAssignment
                setPostAssignment
                setPreIf
                setPostIf
                setPreElse
                setPostElse
        

Parameters:
form - the host 'JFormForm'...
refFld - the 'JFormField' to perform the assignment on...
assignmentIN - the encoded 'assignment' String...
aType - the assignment type [see 'aType' above]...
flowControlIN - current Flow Control Value...
Returns:
Assignment Result String...

verifyBranch

public static void verifyBranch(java.lang.String hostJFormFieldID,
                                java.lang.String branchJFormFieldID)

appendBranchVerifySynopsis

public static void appendBranchVerifySynopsis(java.lang.String s)

prefixBranchVerifySynopsis

public static void prefixBranchVerifySynopsis(java.lang.String s)

bgcolor

public static java.lang.String bgcolor(java.awt.Color c)
 Return the given color [c] in HTML bgcolor Hex Format.
 Example: Util.bgcolor(Color.red) = "ff0000";
 
 Kernel Usage:
 Used to buile tool tip strings.
 

Parameters:
c -
Returns:
String of bgColor...

bitSet

public static boolean bitSet(int source,
                             int bit)
 Return a boolean flag as a function of the indicated bit's setting.
 If the bit is set, return a 'true' flag
 Else retunr a 'false' flag...
 Example: Util.bitSet(8,3) = true;
          Util.bitSet(8,4) = false;
 

Parameters:
source - String of 't' or 'f' characters...
bit - The character [int] to unpack to a boolean[range 0 to n]...
Returns:
boolean of the selected character...

bitSetString

public static java.lang.String bitSetString(int source,
                                            int bit)
 Return a String flag annotation [i.e. "true" OR "false"] as a function of a
 int value [source] and an int bit pointer, i.e. if the bit is set, 
 return a " true" annotation String, else return a "false" String...
 Example: Util.bitSetString(8,3) = "true";
          Util.bitSetString(8,4) = "false";
 

Parameters:
source - a int value.
bit - the bit of 'source' to evaluate...
Returns:
the appropriate "true" OR "false" String...

booleanToString

public static java.lang.String booleanToString(boolean flag)
        Convert a given 'boolean' [flag] to a "T" or "F" String...
        Example: Util.booleanToString(true)  = 'T'
        Example: Util.booleanToString(false) = 'F'
        

Parameters:
flag - given boolean flag...
Returns:
A "T" OR "F" String...

buildSavedQuery

public static java.lang.String buildSavedQuery(JFormField fld)
        Build and return a JFormTKDB.itemsDelimiter delimited String that contains the
        parameters of the given 'JFormField' that are required to reconstruct the
        _QField 'JFormField' of a 'jFormTK' Kernel "Group Set". The reconstruction
        required fields are as follows:
                -       'JFormField' [fld] ID
                -       'JFormField' [fld] JFormField JLabel Text
                -       'JFormField' [fld] Prompt ???
                -       'JFormField' [fld] HintText
 
        This constructed String is saved in the 'savedQuery' field of each 'JFormField'
        added to a 'jFormTK' Kernel "Group Set" via a "Positive" Response to the
        _QField Query.
 
        When a new 'jFormTK' Kernel "Group Set" is built by the 'jFormTK' Kernel each
        'JFormField' of the "Source" Group Set is checked for a non Null 'savedQuery'
        control.
        If a 'savedQuery' Non Null Control is found
        Then
                the 'jFormTK' Kernel shall use the unpacked fields of the 'savedQuery'
                Control to reconstruct the _QField 'JFormField'. This reconstructed
                'JFormField' is placed in the new 'jFormTK' Kernel "Group Set" and all
                JFormField's that have the same 'savedQuery' control are NOT placed into
                the new "Group Set".
 
        NOTE:
        Multiple _QFields in a Group Set shall be allowed because their 'savedGroup'
        controls are different... 
        

Parameters:
fld - QField Source 'JFormField'
Returns:
Saved Query String...

buildStyledMessage

public static java.lang.String buildStyledMessage(java.lang.String m)
        Build a new Message string with "Style" parameters iff the
        'AppDB.JMessagePhrase' object is NOT Null.

        The revised Message [m] shall be formatted as Follows for processing by the
        Run Time 'Util.setStyle Method:
                1)      A word 'phrase'
                2)      'JFormTKDB.assignmentDelimiter'
                3)      LAF Code: "p" for "Message" OR "s" for "Message Prompt"
                        OR "vLAF" where "v" signals a Variable LAF specified by
                        the 'jFormTK' Developer and "LAF" is the "Encoded LAF"
                        Format, e.g. "vcBlue_cWhite_fMonospaced/BOLD/12|T_F_F"
                NOTE:   "p" Uses the 'jFormTKDB.messageLAF...
                                "s" Uses the 'jFormTKDB.messagePhraseLAF'...
                4)      'jFormTKDB.groupSaveDelimiter'

        If the 'AppDB.JMessagePhrase' is Null,
        Then no processing is required on the given 'jFormTK' message...

        Kernel Usage:
        1)      Called from 'this.setStyle' Method...
        2)      Called from 'JMessage.doPrint' Method...
        

Parameters:
m - The Prompt or annotation String to be "Styled"...
Returns:
The Annotated String...

buildStyledPrompt

public static java.lang.String buildStyledPrompt(java.lang.String p)
        Build a new Prompt string with "Style" parameters iff the 'AppDB.JPromptPhrase'
        object is NOT Null...
 
        The revised Prompt [p] shall be formatted as Follows for processing by the Run
        Time 'jFormFrame.setPrompt Method:
        1)      A word 'phrase'
        2)      'jFormTKDB.assignmentDelimiter'
        3)      LAF Code: "p" for "Prompt" OR "s" for "Styled Prompt" OR "vLAF" where "v"
                signals a Variable LAF specified by the 'jFormTK' Developer and "LAF" is
                the "Encoded LAF" Format,
                e.g. "vcBlue_cWhite_fMonospaced/BOLD/12|T_F_F"
        NOTE:   "p" Uses the 'jFormTKDB.promptLAF...
                        "s" Uses the 'jFormTKDB.promptPhraseLAF'...
        4)      'jFormTKDB.groupSaveDelimiter'...
 
        If the 'AppDB.JPromptPhrase' is Null,
        Then no processing is required on the given 'jFormTK' prompt...
 
        Kernel Usage:
        1)      Called from the 'jFormTK.JFormField.init' Method when setting the
                prompt provided to the 'jFormField' Constructor.
        2)      'jFormField' to setup the _QField Prompt Line...
        3)      'jFormField' to setup the _PField Prompt Line...
        

Parameters:
p - Unformatted Prompt String
Returns:
Encoded Prompt [Styled] String...

charToString

public static java.lang.String charToString(char c)

check_QField

public static boolean check_QField(JFormField fld)
        Return a boolean flag as a function of the given 'JFormField' [fld] Type
        [==_QField], the current _QField Value [Yes OR No] and the associated Hint Text
        "Yes" OR "No" existence, e.g. if the current 'JFormField' selection value is "Yes"
        and the "Yes" String if found in the Help Text, Then the return flag is set to
        true so that the 'doButton' Method shall proceed to process the request...

        Kernel Usage:
        1)      Special case for 'JFormForm' Sub-Class usage...
        

Parameters:
fld - Host 'JFormField' to be evaluated...
Returns:
Return Boolen flag...

checkBit

public static boolean checkBit(int source,
                               int bit)

clearBit

public static int clearBit(int source,
                           int bit)

control

public static byte control(java.lang.String s)
        Return the 'byte' Control

        Kernel Usage:
        1)      'JFormField.[5]' Constructor to convert the saved Focus Change Controls
                from the String Array elements to the byte control...
        

Parameters:
s - String Array element that contains a Focus Change Control...
Returns:
The converted 'byte' Control...

compareNames

public static boolean compareNames(java.lang.String text,
                                   java.lang.String addressBook)

concatenateVectors

public static void concatenateVectors(java.util.Vector vA,
                                      java.util.Vector vB)

convertMonthsYears

public static java.lang.String convertMonthsYears(java.lang.String base,
                                                  java.lang.String inNext)

convertName

public static java.lang.String convertName(java.lang.String name)

convertName

public static java.lang.String convertName(java.lang.String nameIn,
                                           java.lang.String type)

countFormFields

public static int countFormFields(JFormForm form,
                                  java.lang.String name)
        Compute the number of JFormField's in the JFormForm Fields Vector [formFields]
        with the specified LABEL Field Name [fldName]...

        Kernel Usage:
        1)      Called by 'JFormFrame.addField' Method to compute the 'Set Number' of the
                new     'JFormField' being added to the 'formFields' Vector...
                NOTE:
                Set Numbers are used when the 'JFormField' is in a 'jFormTK' "Group"...
        

Parameters:
form - 'JFormForm' Sub-Class Name [String]...
name - 'JFormField' Name [String]...
Returns:
Count of the number of 'JFormForm' fields with the given name...

dateDifference

public static int dateDifference(java.util.Date first,
                                 java.util.Date last)

dateDifference

public static int dateDifference(java.lang.String first,
                                 java.lang.String last)

displayUtilDynamicMethods

public static java.lang.String displayUtilDynamicMethods()

daysFromNow

public static int daysFromNow(java.util.Date date)

daysFromNow

public static int daysFromNow(java.lang.String date)

decrementRowNumbers

public static void decrementRowNumbers(JFormForm form,
                                       int foundObjectIndex,
                                       int removedRow)

decrementRowNumbers

public static void decrementRowNumbers(JFormForm form,
                                       int foundObjectIndex,
                                       int removedRow,
                                       int delta)

displayFormFields

public static void displayFormFields(JFormForm form,
                                     java.lang.String from)

displayHexArray

public static java.lang.String displayHexArray(java.lang.String heading,
                                               byte[] b)
        Convert the given Array of bytes [b] to a String [display] in a
        Hex Format. The byte elements are displayed in Hex with a Comma Delimiter.
        The last comma is NOT returned...

        Kernal Usage:
        1)      'JFormInfo.displayECrypt' Method...
        2)      'JHDD_IO.doEncrypt' Method iff debug flag is ON...
        3)      'JHDD_IO.doDecrypt' Method iff debug flag is ON...
        

Parameters:
heading - Heading [String] in the formatted display String...
b - Array of bytes to display in Hex format...
Returns:
display The constructed Hex Display String...

displayUnexpectedDoCaseWarning

public static void displayUnexpectedDoCaseWarning(JFormForm form,
                                                  JFormField fld,
                                                  java.lang.String module)
        Display a Warning message when the 'default' branch of a Do Case [switch] is
        encountered...

        Kernel Usage:
        1)      Used by the 'jFormTK.JFormForm' Developer SubClass's pre/post processor's
                DOCASE 'default' operation...
        

Parameters:
form - 'JFormForm' SubClass Reference...
fld - 'JFormField' where the unexpected pre/post DOCase is serviced...
module - String to annotate the calling 'jFormTK' Application Method...

doAbort

public static void doAbort(java.lang.String from)

doAbort

public static void doAbort(javax.swing.JPanel panel,
                           java.lang.String from)

doAbort

public static void doAbort(javax.swing.JPanel panel,
                           java.lang.String from,
                           boolean abort)

doIfAssignment

public static java.lang.String doIfAssignment(JFormForm form,
                                              JFormField fld,
                                              java.lang.String ifType,
                                              java.lang.String flowControlIn,
                                              java.lang.String from)
 Perform the given Run Time 'If' assignment as a function of the given processor 
 type [ifType], that is ifType = "pre" OR "post" IF Assignement...
 
 Kernel Usage:
 1) Called by the 'JFocus.preProcess' Method when the 'JFormField' that is about 
    to be focused has it's "Pre If" Condition Parameter set...
 2) Called by the 'JFocus.doPostProcess' Method when the last focused 'JFormField' 
    has it's 'ifPostAssignment' control set...
 

Parameters:
form - Host 'JFormForm' SubClass Reference...
fld - Host 'JFormField' instance
ifType - IF Type, i.e. "pre" OR "post"...
from - DEBUG annotation String

ensureLastCharacter

public static java.lang.String ensureLastCharacter(java.lang.String sIN,
                                                   java.lang.String del,
                                                   java.lang.String from)
        Ensure that the last character in the given String [sIN] is equal to the given
        delimiter [del]. This method is used prior to performing an unpacking operation
        using "del" as the unpacking delimiter AND several location to verify that an
        "Encoded" String is properly formatted...

        If the given String is 'null'
        Then the return String is set to the delimiter [del]...

        Kernel Usage:
        1)      'this.setColor' Method...
        2)      'this.setFont' Method...
        3)      'this.unpackToIntArray' Method...
        4)      'this.unpackToStringArray' Method...
        5)      'this.verifyFields' Method...
        6)      'AppCommonDB.getPromptPhraseList' Method...
        7)      'DynamicFieldControls.getInsertFields' Method...
        

Parameters:
sIN - String to be unpacked...
del - The fields delimiter [String]...
Returns:
The adjusted String with the last 'char' set to 'del'...

ensureSetNumber

public static java.lang.String ensureSetNumber(java.lang.String sIN)

fillString

public static java.lang.String fillString(int in,
                                          java.lang.String fill,
                                          int length)

fillString

public static java.lang.String fillString(java.lang.String s,
                                          char c,
                                          int n)
 RIGHT fill the given String [s] with the given 'char' [c] to a given total length [n]...
 

Parameters:
s - Source String
c - Fill Character [char]
n - Number of characters, i.e. width of formatted field...
Returns:
Formatted String

fillString

public static java.lang.String fillString(java.lang.String sIn,
                                          java.lang.String fill,
                                          int n)
 Add the given Fill String [fill] to the end of the given String [sIn] till the adjusted
 String is a given number of characters [length]...
 

Parameters:
sIn - Source String
fill - Fill String to be appended
n - Number of times to fill the given fill...
Returns:
Formatted String...

fillString

public static java.lang.String fillString(boolean flag,
                                          java.lang.String fill,
                                          int n)

findFieldName

public static int findFieldName(java.util.Vector fieldNames,
                                java.lang.String inFieldName)

findJFormFieldIndex

public static int findJFormFieldIndex(JFormForm form,
                                      java.lang.String inID)
        Return the formFields Vector index for the given 'JFormField' ID...

        Kernel Usage:
        1)      'JValue' when a 'JFormField.reference' control string has found a
                "Referenced JFormField' in the same 'JFormForm' SubClass. It is used to
                ensure that the found internal reference is NOT a Forward Reference...
        

Parameters:
form - Host 'JFormForm' SubClass Reference...
inID - 'JFormField' ID to be found in the 'formField' Vector of the given 'JFormForm' SubClass [form]...
Returns:
The 'formField' Vector Index to the found 'JFormField' ID OR a "-1" if the ID is NOT Found...

findStringArrayElement

public static int findStringArrayElement(java.lang.String element,
                                         java.lang.String[] array)

firstActiveJFormField

public static JFormField firstActiveJFormField(JFormForm form)
 Find the first "Active" 'JFormField' of the given JFormForm's [formFields] Vector...
 
 Note:
 If the given 'JFormForm' has never been set before,
 Then no 'JFormField's currently exist and the return Object
       shall be a 'null' JFormField Reference...
 
 Kernel Usage:
 1) 'JField.setJFormField' Method when a 'null' Field is given to the 
     'JField.setJFormField' Method...
 2) 'jFormState.getCurrentJFormField'Method when the current JFormField
     "State" parameter is 'null' or blank...
 

Parameters:
form - Reference to the 'JFormForm' SubClass to find the 1st Active 'JFormField'...
Returns:
first "Active" 'JFormField' reference...

firstHalfString

public static java.lang.String firstHalfString(java.lang.String inS)

floatToAmount

public static java.lang.String floatToAmount(float fAmount)

floatToString

public static java.lang.String floatToString(float fAmount)

getAD

public static int getAD(java.lang.String in)

getAnchor

public static java.lang.String getAnchor(JFormForm form,
                                         JFormField jFld)
 Construct the 'JAddressBook' unique "Anchor" from the given 'JFormField' parameters. The "Anchor"
 String uses the "Dot" Notation as Follows:
    "Category.SubSategory.FileName.GroupName.FieldName.SetNumber" where 'Null' Fields are excluded...
 

Parameters:
form - Current 'JFormForm' SubClass Reference.
jFld - "Reference" to the current 'JFormField' instance...
Returns:
A 'jFormTK' JAddressBook Anchor...

getAnchor

public static java.lang.String getAnchor(java.lang.String category,
                                         java.lang.String fileName,
                                         java.lang.String inGroupName,
                                         java.lang.String fieldName,
                                         java.lang.String setNumber)
 Construct the 'JAddressBook' unique "Anchor" from the given 'JFormField' parameters. The "Anchor"
 String uses the "Dot" Notation as Follows:
    "Category.SubSategory.FileName.GroupName.FieldName.SetNumber" where 'Null' Fields are excluded...
 

Parameters:
category - Category String
fileName - Form File Name String
inGroupName - Group Name String
fieldName - Field Name Stgring
setNumber - Set Number String
Returns:
A 'jFormTK' JAddressBook Anchor...

getBorder

public static javax.swing.border.Border getBorder(int borderControl,
                                                  java.awt.Color lineBorderColor)

getBorder

public static javax.swing.border.Border getBorder(JLAF laf)

getBreakpointAnnotation

public static java.lang.String getBreakpointAnnotation(int breakpoint)

getChoiceDate

public static java.lang.String getChoiceDate(java.lang.String choiceField)

getChoiceDate

public static java.lang.String getChoiceDate(java.lang.String choiceField,
                                             java.lang.String associatedValues)

getChoiceNumber

public static java.lang.String getChoiceNumber(java.lang.String choiceField)

getChoiceNumber

public static java.lang.String getChoiceNumber(java.lang.String choiceField,
                                               java.lang.String associatedValues)

getChoiceSelection

public static java.lang.String getChoiceSelection(java.lang.String choiceField)

getColor

public static java.lang.String getColor(java.awt.Color c)

getColorForFont

public static java.lang.String getColorForFont(java.awt.Color c)
 Produce a  String the contains the "red", "green" and "blue" components of a Color Object 
 with the "/" Delimiter and NO "c" prefix. This color String format is
  used in a  clause to set a Font Color...
 

Parameters:
c - The color component...
Returns:
String the contains the "red", "green" and "blue" components...

getColorEncoded

public static java.lang.String getColorEncoded(java.awt.Color c)
 Produce a  String the contains the "red", "green" and "blue" components of a Color Object 
 with the "/" Delimiter and the  "c" prefix. This color String format is*
  used to set the Colors of the 'jLAF' Class instances...
 

Parameters:
c - The Color Component...
Returns:
String the contains the "red", "green" and "blue" components...

getColorEncodedHEX

public static java.lang.String getColorEncodedHEX(java.awt.Color c)
 Produce a  String the contains the "red", "green" and "blue" components of a Color Object 
 with the "/" Delimiter and the  "c" prefix. This color String format is*
        // *  used to set the Colors of the 'jLAF' Class instances...
 

Parameters:
c - The Color component...
Returns:
String the contains the "red", "green" and "blue" components

getCurrentAssignmentField

public static JFormField getCurrentAssignmentField()

getCurrentFormID

public static java.lang.String getCurrentFormID()
DEBUG method to get the 'JFormForm' ID for the current 'JFormForm' SubClass...

Returns:
'JFormField' ID String OR 'Null' annotation...

getCurrentField

public static JFormField getCurrentField()
DEBUG method to get the 'JFormField' for the current 'JFormField...

Returns:
JFormField REF for current 'JFormField'...

getCurrentJFormFieldID

public static java.lang.String getCurrentJFormFieldID()
DEBUG method to get the ID for the current 'JFormID.JFormField...

Returns:
Form ID String OR 'Null.Null' annotation...

getDateString

public static java.lang.String getDateString()
        Get the System Date and convert it to a 'jFormTK' Standard String
        Format as follows:

        "MM/d/yyyy hh:mm:ss aa" for example: "01/28/2000 09:19:12 AM"

        Kernel Usage:
        1)      Called by the jFormTK 'JFormInfo' Constructor when creating
                the initial Class Instance date Strings...
        2)      Used by the jFormIO 'WriteToFile' Method to produce the
                JFormInfo 'DateModified' String...

Returns:
Date String [MM/d/yyyy hh:mm:ss aa]

getDateTime

public static java.lang.String getDateTime()
        Return the current Date and Time information from the Platform's 
        System Clock in the following format:   "mmddyyyyhhmmss".
 

Returns:
The "mmddyyyyhhmmss" String for current Date and Time...

getDisplayLines

public static int getDisplayLines(java.lang.String s,
                                  int nCharPerLine)
        Compute the approximate number of didplay lines in the given [s] String.
        The processing considers the Line Feed's [JConstants.LF] in the message and
        tries to guestimate the JTextArea dislay lines = f(the char per line)...

        This calculation is only a WAG [Wild Assed Guess] but is sufficient for it's
        design usage, i.e. determining if a String shall be split into multiple table
        entries so that the JPDF will function as designed.

        Kernel Usage:
        1)      'JWorkSheetTypeDialog.doPrinter' method when producing the JPDF JTextArea Swing
                component's for the "Information Text" 'jFormTK' Work Sheet printer... 
        

Parameters:
s - The String to be displayed...
nCharPerLine - The # [int] of 'char' per display line...
Returns:
The 'int' estimate of the number of Display lines...

getDynamicReferences

public static java.lang.String getDynamicReferences(java.lang.String s)
        Unpack each 'jFormTK' Dynamic Reference of the given String [s] and pack
        the references into the return String using the 'JFormTKDB.itemsDelimiter'...

        Kernel Usage:
        1)      'JReportData.buildReferences' Method...
        

Parameters:
s - String that MAY contain1 or more 'jFormTK' Dynamic References...
Returns:
String of unpacked references delimited via the 'JFormTKDB.intemsDelimiter'...

getDynamicReferences

public static java.lang.String getDynamicReferences(java.lang.String sIn,
                                                    java.lang.String del)
        Unpack each 'jFormTK' Dynamic Reference of the given String [s] and pack
        the references into the return String using the given Delimiter [del]...

        Kernel Usage:
        1)      'this.getDynamicReferences' No Delimiter Method...
        

Parameters:
sIn - String that MAY contain1 or more 'jFormTK' Dynamic References...
del - Delimiter [String] between references items...
Returns:
String of unpacked references delimited with the 'del' String...

getElementDelimiter

public static java.lang.String getElementDelimiter(JFormField fld)
        Return the 'element' Delimiter for the given 'JFormField' [fld]
        =F[JFormTKDB.elemetDelimiter] Array...

        Kernel Usage:
        1) 'DynamicFieldControl.constructor' for usage by 'load' and 'toString' Methods...
        

Parameters:
fld - The 'JFormField' instance to fetch the element delimiter from...
Returns:
The Element Delimiter String...

getFieldsDelimiter

public static java.lang.String getFieldsDelimiter(JFormField fld)
        Return the 'fields' Delimiter for the given 'JFormField' [fld]
        =F[JFormTKDB.fieldsDelimiter] Array...

        Kernel Usage:
        1) 'DynamicFieldControl' for usage by 'load' and 'toString' Methods...
        

Parameters:
fld - The 'JFormField' instance to fetch the element delimiter from...
Returns:
The 'fields' Delimiter String...

XXXdelay

public static void XXXdelay(int seconds)
        LOOP [delay] within this method for the number of seconds specified by the
        End User.

        NOTE:   DEBUG method used to simulate know conditions while doing various
                        Kernel Test operations... 
        

Parameters:
seconds - An 'int' that contains the delay time in seconds...

twoDigits

public static java.lang.String twoDigits(int in)
        Ensure that the given 'int' [in] consist of two digits. The leading
        digit is filled with a zero character...
 
        Kernel Usage:
        1)      Called exclusively by the '*this*.getDateTime' Method...

Parameters:
in - Input int
Returns:
String of 2 characters with a zero leading character if in > 9.

getDays

public static int getDays(java.lang.String day1,
                          java.lang.String day2)

getDaysFromToday

public static int getDaysFromToday(java.lang.String day)

getDaysCount

public static int getDaysCount(java.util.Date earlier,
                               java.util.Date later)
the difference in days between 2 dates within the Gregorian calendar - after 1582

Parameters:
earlier - the start date
later - the end date
Returns:
number of days

getDoCase

public static int getDoCase(java.lang.String name,
                            java.lang.String[] objects)
        Return the 'int' for the item of the given String [name] in the given String
        Array [objects]. If no match, return -1.

        Kernel Usage:
        1)      Used by the 'jFormTK.JFormForm' Developer Class's pre/post processor to
                establish an 'int' to be used by a 'switch' DOCASE of the 'JFormField'...
        2)      'this.Util.assignment' Method...
        3)      'this.doIfAssignment' Method...
        4)      'this.getUtilityValue' Method...
        5)      'this.parseCondition' Method...
        6)      'this.setAField' Method...
        7)      'this.show' Nethod...
        8)      'JFormTKDB.panelJustification' Method...
        9)      'JFormTKDB.getPanelPosition' Method...
 10)    'JFormTKDB.getJPDFPreviewTypeControl' Method...
 11)    'JFormTKDB.getJPDFPreviewTypeFlag' Method...
 12)    'JFormTKDB.getTablePrintControls' Method...
 13)    'JFormTKDB.getTabPlacement' Method...
 14)    'JFormTKDB.set' Method...
 15)    'JFormTKDB.JTK.decode' Method...
 16)    'JFormTKDB.JTK.getValue' Method...
 17)    'BasejFormTK.selectJFormField' Method...
 18)    'BasejFormTK.MenuAction.actionPerformed' Method...
 19)    'BasejFormTK.SelectField.Constructor' Method...
 20)    'JFocus.doPostProcess' Method...
 21)    'JWorkSheet.Constructor' Method...
 22)    'Main.init' Method...
 23)    'Main.doTABPanel' Method...
 24)    'Focus.preProcess' Method...
 25)    'Focus.postProcess' Method...
 26)    'JAddressBook.getList' Method...
 27)    'JMessage.MessageDialog.actionPerformed' Method...
 28)    'JWorkSheetTypeDialog.BuildActiveFieldTableModel' Method...
        

Parameters:
name - The name [String] to be found in the given String Array...
objects - A String Array of names to be searched...
Returns:
The 'int' for the matched 'name' OR -1 int if 'name' NOT found in 'objects' String...

getDoCase

public static int getDoCase(char name,
                            char[] objects)
        Return the 'int' for the item of the given 'char' [name] in the given char
        Array [objects]. If no match, return -1.

        Kernel Usage:
        1)      Used by the 'jFormTK.JFormForm' Developer Class's pre/post processor to
                establish an 'int' to be used by a 'switch' DOCASE of the 'JFormField'...
        2)      
        

Parameters:
name - The name [String] to be found in the given String Array...
objects - A String Array of names to be searched...
Returns:
The 'int' for the matched 'name' OR -1 int if 'name' NOT found in 'objects' String...

getElementDelimiter

public static java.lang.String getElementDelimiter(int parentNestingLevel)
        Get the 'elementDelimiter' =F[int parentNestingLevel].
        If there is not an available element Delimiter in the JFormTKDB
        Then present a SOFTWARE TRAP Soft Abort...

        Kernel Usage:
        1)      'JFormFrame.addQFieldControls' method iff the parent 'JFormField' is
                a '_QField' and there are "YES", "NO" or Both 'JFormField' Controls...
        

Parameters:
parentNestingLevel - The 'nestingLevel' [int] for the parent JFormField...
Returns:
The calculated Element Delimiter...

getFieldByIndex

public static java.lang.String getFieldByIndex(java.lang.String fieldsString,
                                               int number)

getFieldNamefromAnchor

public static java.lang.String getFieldNamefromAnchor(java.lang.String anchor)

getFieldNames

public static java.util.Vector getFieldNames(JFormForm form)

getFields

public static java.lang.String[] getFields(java.lang.String sIN,
                                           java.lang.String from)
        Method to unpack the fields of the given String and place the fields into the
        elements of the return String Array...

        The given String [sIN] to be unpacked may contain an indirect reference to a
        'JFormField' OR a Prefixed Reference, i.e. a 'jFormTK' ID Value that is evaluated
        using the 'JValue' Class..,

        NOTE 1:
        This method MUST return the fields ASIS, i.e. NOT Trimed because some of the
        fields may have an expected " " value...

        NOTE 2:
        There are two signatures to the method.
        This one does NOT include a delimiter argument. It defaults to the
        'JFormTKDB.fieldsDelimiter' and envokes the 2nd Method signature...
        Kernel Usage:
        1)      'Data.getFields' Method to construct a 'jFormTK' ID from a
                'JFormField' saved String...
        2)?     'EditJFormField.Constructor' to build a String Array of the fields in the
                'ItemsText'     so that they can be placed in the required Java Type...
        3)?     'EditJFormField.Constructor' to build an array of Selected CheckBoxes from
                the 'returnText' String...

        NOTE ?:
        Needs check to determine if 'Util.unpackToStringArray' should be used in lieu of
        'Util.getFields' method...
        

Parameters:
sIN - String to be unpacked...
from - DEBUG String annotation
Returns:
String array of the unpacked values...

XXXgetFields

public static java.lang.String[] XXXgetFields(java.lang.String sIN,
                                              java.lang.String del,
                                              java.lang.String from)
        See Above JavaDoc for method description.

        Kernel Usage:
        1)      
        

Parameters:
sIN - String to be unpacked...
del - Delimiter to unpack the given String...
from - DEBUG String annotation
Returns:
String array of the unpacked values...

getFieldsDelimiter

public static java.lang.String getFieldsDelimiter(int parentNestingLevel)
        Get the 'fieldsDelimiter' =F[int parentNestingLevel].
        If there is not an available fields Delimiter in the JFormTKDB
        Then present a SOFTWARE TRAP Soft Abort...

        Kernel Usage:
        1)      'JFormFrame.addQFieldControls' method iff the parent 'JFormField' is
                a '_QField' and there are "YES", "NO" or Both 'JFormField' Controls...
        

Parameters:
parentNestingLevel - The 'nestingLevel' [int] for the parent JFormField...
Returns:
The calculated Fields Delimiter...

getFirstWord

public static java.lang.String getFirstWord(java.lang.String inString)
        Return the first word of the given String. A 'Word' is defined as the characters
        from the first non-blank character in the input String [inString] up to
        [but not including] the first Blank [' '], [':'], [','], ['.'], ['=']
        OR JFormTKDB Items Delimiter [D_ITEMS]  character...

        Kernel Usage:
        1)      Called by the JFormField' Constructor to fetch the first word of the
                JFormField's Label field so that it can be used as the 'JFormField' Name...
        2)      'Util.getUtilityValue' Method...
        3)      'Util.verifyRange' Method to unpack the given range and check if it is a
                Application Form "Category"...
        4)      'AddressBook.init' Method to verify the 'formula' name...
        5)      'JAddressBook.getLastName' Method...
        6)      'JFormForm.getJFormFieldIndex' method to verify the "Category" of a
                'jFormTK' ID...
        

Parameters:
inString - The String that contains any of the above delimiters...
Returns:
The Unpacked 1st Word String...

getFont

public static java.lang.String getFont(java.awt.Font f)

getFontEncoded

public static java.lang.String getFontEncoded(java.awt.Font f,
                                              boolean bold,
                                              boolean italic,
                                              boolean underline,
                                              java.lang.String from)

getFormula

public static java.lang.String getFormula(java.lang.String formulaIN)

getFormulas

public static java.lang.String[] getFormulas(java.lang.String formulaIN)

getGroupParametersVector

public static java.util.Vector getGroupParametersVector(JFormForm form,
                                                        java.lang.String inGroupName)

getIndex

public static int getIndex(java.lang.String[] sArray,
                           java.lang.String valueIn)
        Return the index into the given String Array [sArray] for the given
        String value [valueIn]. Trim the given value [valueInm].

        Retrun index [index] = -1 iff no match is made...

        Kernel Usage:
        1)      'JDerby_IO.insertAddressBookSegements' to validate the person name
                appendix of the given primary key...
        

Parameters:
sArray - String Array to be searched...
valueIn - String value to be trimmed and searched for...
Returns:
matching index [int] OR -1 if no match found...

unpackInsertFields

public static java.lang.String[] unpackInsertFields(java.lang.String sIn,
                                                    java.lang.String fDel)
        Unpack the last 6 String fields of the given 'savedDynamicFieldControls' String
        and return them in a String array.

        The unpacked String elements are as follows:
                col=            int             'JFormField' Column index...
                newRow          boolean New Row Flag...
                w                       int             'JFormField' width...
                h                       int             'JFormField' HEIGHT...
                groupName       String  'JFormField' Group Name...
                repeatMode      String  'JFormField' Repeat Mode Control...

        NOTE:
        1)      This utility is used to fetch the Insert Field Parameters that are appended
                to the end of the saved 'DynamicFieldReference' String by the
                'DynamicFieldReference.toString' method...

                The invoking method uses the constructed String Array to set the 'JFormField'
                parameters that are generally provided by the 'JFormFrame.addField' and
                'JFormFrame.insertField' methods... 
        

Parameters:
sIn - The 'savedDynamicFieldControls' String...
fDel - The fields delimiter for the 'savedDynamicFieldControls' String...
Returns:
String Array of the Insert Field Controls...

getItemsString

public static java.lang.String getItemsString(double[] items)
        Translate an Array of 'double' items into a single String using the
        D_ITEMS...

        Kernel Usage:
        1)      Not currently used in the 'jFormTK' Kernel...
        

Parameters:
items - An array of 'double' values...
Returns:
A String with the double values delimited by the D_ITEMS String...

getItemsString

public static java.lang.String getItemsString(java.lang.String[] items)
        Translate an Array of 'String' items into a single String using the
        D_ITEMS...

        Kernel Usage:
        1)      Not currently used in the 'jFormTK' Kernel...
        NOTE:
        See the 'fyiItems' method for a '' method designed to display a String
        of this format where the 'items' values are 'JFormField' ID's...
        

Parameters:
items - An array of 'String' values...
Returns:
A String with the String values delimited by the D_ITEMS String...

getJFormField

public static JFormField getJFormField(java.lang.String formIDIn)
        Get a reference to the 'JFormField' specified by the given "Full"
        'jFormYK' ID [formIDIn].

        If the Indirect Reference controls [Parens] exist,
        Then Strip them and proceed to find the referenced Form/Field...

        If no FormID is found in the given ID
        Then the JFormFrame.currentForm is used...

        Kernel Usage:
        1)      TBD...
        

Parameters:
formIDIn - Full 'jFormTK' ID...
Returns:
The found 'JFormField' reference...

getJFormField

public static JFormField getJFormField(JFormForm form,
                                       int row,
                                       int col)

getJFormField

public static JFormField getJFormField(JFormForm form,
                                       JFormField currentFld,
                                       java.lang.String fieldName)

getJFormField

public static JFormField getJFormField(JFormForm form,
                                       java.lang.String fldID,
                                       java.lang.String from)
        Get a "Reference" to a specific 'JFormField' from the given JFormForm [form],
        and the 'JFormField' ID...

        Note:
                If the given 'JFormField' ID is "None"
                Then
                        return the 1st "Active" 'JFormField' of the given 'JFormForm' Sub-Class...

        Kernel Usage:
        1)      'JFormField.getAddressBookName' Method...
        2)      'JValue.Constructor'...
        

Parameters:
form - The 'JFormForm' Sub-Class instance...
fldID - The 'JFormField' ID...
from - DEBUG String to annotate the calling Class.Method...
Returns:
The found 'JFormField' Reference...

getJFormField

public static JFormField getJFormField(JFormForm form,
                                       java.lang.String groupNameIn,
                                       java.lang.String fieldNameIn,
                                       java.lang.String setNumber)
        This method is designed to Get a "Reference" to a specific 'JFormField' from the
        given JFormForm [form] , 'Group Name' [GroupName], 'Field Name' [FieldName] and
        'Set  Number' [SetNumber]...

        Kernel Usage:
        1)      'addressBook.doGoToForm' Method...
        2)      '"NotePad.selectJFormField_s.doAnnotate' Method...
        3)      'AppForms.getJFormField' Method...
        4)      'quickEditDialog.doGoTo' Method...
        5)      Various Application Specific 'JFormForm' subClasses...
        

Parameters:
form - Host 'JFormForm' reference...
groupNameIn - Group Name String...
fieldNameIn - File Name String...
setNumber - Set Number String...
Returns:
'JFormField' found for the given ID OR a 'null' iff not found...

getJFormField

public static JFormField getJFormField(java.lang.String fieldName,
                                       JFormForm form)
        Get a "Reference" to a specific 'JFormField' from the given Field Name
        [fieldName] of the specified 'JFormForm' [form]. Used when the required
        'JFormField' is NOT in a Group [and therefore, the setNumber is zero]...

        Kernel Usage:
        1)      Application Developer's 'JFormForm' SubClass that define's a new specific
                Application Form...
        

Parameters:
fieldName -
form -
Returns:
Found 'JFormField' Reference

getJFormField

public static JFormField getJFormField(java.util.Vector jFormFields,
                                       java.lang.String formIDIN)
        Get a "Reference" to a specific 'JFormField' from the given Field ID
        [fieldNameIDIN] of the specified 'JFormForm' [form]...

        Kernel Usage:
        1)      Application Developer's 'JFormForm' SubClass that define's a new specific
                Application Form...
        

Parameters:
jFormFields - Vector of 'jFormFields' instances...
formIDIN - 'JFormForm' Sub-Class ID String...
Returns:
Found 'JFormField' Reference

getJFormFieldIndex

public static int getJFormFieldIndex(JFormField fld,
                                     java.util.Vector jFormFields)
        Return the index into the given 'JFormFields' Vector for the specified
        'JFormField' instance...
        If the 'JFormField' is NOT found,
        Then return a '-1' index...

        Kernel Usage:
        1)      'BasejFormTK.doFormsPanelTAB' Method to set the Show Panel Focus to the
                last focused 'JFormField' of the current 'JFormForm SubClass'...
        

Parameters:
fld - The target 'JFormField' reference
jFormFields - The 'JFormFields' Vector for the host 'JFormForm' SubClass...
Returns:
The index [int] into the 'jFormFields' Vector [jFormFields]...

getJFormFieldIndex

public static int getJFormFieldIndex(JFormForm form,
                                     JFormField fld)
        Return the index into the given 'JFormForm.Dub-Class' jFormFields Vector for the
        specified 'JFormField' instance...
        If the 'JFormField' is NOT found,
        Then return a '-1' index...

        Kernel Usage:
        1)      'JFormField.doPostProcess' after the host JFormForm.Sub-Class fields have
                been modified via a _QField process...
        

Parameters:
form - Host 'JFormForm.Sub-Class'...
fld - The target 'JFormField' reference
Returns:
The index [int] into the 'jFormFields' Vector [jFormFields]...

XXXgetJFormFieldIndex

public static int XXXgetJFormFieldIndex(JFormForm form,
                                        int row)
        Method to compute the formFields Vector index for the given Row.
        NOTE:
        There may be multiple JFormField's in the given Row.
        This routine is designed to return the index for the first 'JFormField' found 
        for the specified 'Row'...
 
 Kernel Usage:
 1)     Called from 'JFormFrame.showPage' when the specified form is already loaded
        and only the Focus setting is required...
 

Parameters:
form - 'JFormForm' Reference for the Form to be searched...
row - The Row Number [int] to find the return 'JFormField'
Returns:
The found 'JFormField' Reference

getJFormFieldTrace

public static java.lang.String getJFormFieldTrace(JFormField fld)
        Construct and return a String to be used in the 'Focus Trace' feature.
        Set the return String to the ID., Type and text parameters From the 
        given 'JFormField' instance [fld].

        Delimit each field with the 'jFormTK' Items Delimiter dervived from the
        'JFormTKDB' Data Base...

        Kernel Usage:
        1)      'JFocus.adddFocus' method to build the Focus 'Record' String...
        2)      By 'jFormTK' Application developers as required... 
        

Parameters:
fld - Reference to the 'JFormField' to be traced...
Returns:
String with 'fld's Trace Parameters...

getJLAFEncoded

public static java.lang.String getJLAFEncoded(JLAF laf)

getJMessageTopic

public static java.lang.String getJMessageTopic(java.lang.String messageIn)
        Return a String with each 'AppDB.JMessageTopic' instance Reference
        [i.e. "(def: element_name)"] changed to the "Matching" 'element_name" Text...

        Kernel Usage:
        1)      'jFormFrame.displayHelp' Method...
        2)      'jFormFrame.displayHint' Method...
        3)      'jFormFrame.displayInfo' Method...
        

Parameters:
messageIn - Message [String] to be searched...
Returns:
String with each 'AppDB.JMessageTopic' instance Reference...

getLabelName

public static java.lang.String getLabelName(java.awt.Label label)

getLastCharacter

public static java.lang.String getLastCharacter(java.lang.String s)
        Return the last character in the given String [s]...

        Kernel Usage:
        1)      'JDerby_IO.insertAddressBookSegment' to fetch the Address Book name key
                appendex while validating the given address book key...
        

Parameters:
s - The String to be unpacked from...
Returns:
The last character String or a null String if the given String is a null String...

getLastName

public static java.lang.String getLastName(java.lang.String in)

getLastName

public static java.lang.String getLastName(java.lang.String in,
                                           java.lang.String del)

getLastRow

public static int getLastRow(JFormForm form)

getLastWord

public static java.lang.String getLastWord(java.lang.String inString,
                                           java.lang.String del)
        Return the last field [String] of the given String [inString] following the
        last Delimiter [del]...

        Kernel Usage:
        1)      'JFocus.doPostProcess' Method when unpacking the "Set Number" from
                a Highlite Control Set "Range" parameter...
        

Parameters:
inString - The Input String with a delimited set of fields...
del - The Delimiter used in 'inString'...
Returns:
The unpacked Last Word...

getNameString

public static java.lang.String[] getNameString(JFormField fld,
                                               java.lang.String from)
        Return a String Array that contains the following elements:
                [0] - First Name; [1] - Middle Name;
                [2] - Last Name;  [3] - suffix [e.g. Jr.]...
        NOTE: This method should only be used on _TField JFormField's where the content of
        the JFormField contains a person's Name...

        Kernel Usage:
        1)      Used by the 'JAddressBook.add' Method...
        2)      Called by various Developer pre / post Processor Methods when a End User
                provided Name is to be added to the 'jFormTK.JAddressBook' instance...
        3)      'JAddressBook.findName' Method to convert the given Name to the
                'JAddresBook.name' format, i.e. lastName, firstName, MiddleName[Initial],
                suffix...
        

Parameters:
fld - 'JFormField' instance...
from - DEBUG String to annote the calling Class.method...
Returns:
Constructed String Array...

getNameString

public static java.lang.String[] getNameString(java.lang.String nameString,
                                               java.lang.String from)
        Return a String Array that contains the following elements:
                [0] - First Name; [1] - Middle Name;
                [2] - Last Name;  [3] - suffix [e.g. Jr.]...
        NOTE: This method should only be used on _TField JFormField's where the content of
        the JFormField contains a person's Name...

        Kernel Usage:
        1)      Used by the 'JAddressBook.add' Method...
        2)      Called by various Developer pre / post Processor Methods when a End User
                provided Name is to be added to the 'jFormTK.JAddressBook' instance...
        3)      'JAddressBook.findName' Method to convert the given Name to the
                'JAddresBook.name' format, i.e. lastName, firstName, MiddleName[Initial],
                suffix...
        

Parameters:
nameString - 'JFormField' Name String...
from - DEBUG String to annote the calling Class.method...
Returns:
Constructed String Array...

getNumberOfFields

public static int getNumberOfFields(java.lang.String s,
                                    java.lang.String del)

getNumberOfWords

public static int getNumberOfWords(java.lang.String sIN)

getPostTrace

public static java.lang.String getPostTrace(JFormField fld)
 Construct and return a String to be used in the 'Focus Trace' feature.
 Set the return String to the Post Processor Flag and the Post Processor
 Object Fields. Delimit each field with the 'jFormTK' Items Delimiter 
 dervived from the 'JFormTKDB' Data Base... 
 

Parameters:
fld - Reference to the 'JFormField' to be traced...
Returns:
String with 'fld's Post processor Parameters...

getPreTrace

public static java.lang.String getPreTrace(JFormField fld)
 Construct and return a String to be used in the 'Focus Trace' feature.
 Set the return String to the Pre  Processor Flag and the Pre  Processor
 Object Fields. Delimit each field with the 'jFormTK' Items Delimiter 
 dervived from the 'JFormTKDB' Data Base... 
 

Parameters:
fld - Reference to the 'JFormField' to be traced...
Returns:
String with 'fld's Pre processor Parameters...

getPreviousActiveJFormField

public static JFormField getPreviousActiveJFormField(JFormForm form,
                                                     JFormField fld)

getScrollBar

public static javax.swing.JScrollBar getScrollBar(javax.swing.JScrollPane sp,
                                                  java.awt.Color background,
                                                  java.awt.Color foreground,
                                                  char mode,
                                                  char cColor)
        Get the 'mode' JScrollBar from the given JScrollPane and set the LAF as a
        function of the given background / foreground Colors. The 'mode' is 'H' for
        Horizontal JScrollBar OR mode is 'V' for Vertical JScrollBar. The JScrollBar
        components Color set = f[cColor] control...

        NOTE:   8/7/2007
        Mac OS X 'JScrollBar' does not have sliding components.
        Therefore, the 'jFormTK' test on the Mac OS X node ran into a snag because
        some of the 'jFormTK' java code set the JScrollBar Colors after the call to
        this method. To fix this platform compatability problem the 'cColor'
        parameter was added to allow the 'jFormTK' developer to control which Color
        shall be used to set the component Background...

        After this revision, all references to the JScrollBar components are made in
        this utility method...

        Kernel Usage:
        1)      Throughout the 'jFormTK' when setting up the Look and Feel for Java
                components that employ a JScrollPane...
        

Parameters:
sp - JScrollPane that contains the "default" JScrollBars
background - Background [Color]
foreground - Foreground [Color]
mode - Char Mode Control ['H' OR 'V']
cColor - Component Color control ['f' OR 'b']
Returns:
Constructed JScrollBar...

getRangeValue

public static java.lang.String getRangeValue(java.lang.String line,
                                             char rangeOpen,
                                             char rangeClose)

getSerialNumber

public static java.lang.String getSerialNumber(java.lang.String State)

getSplitIndex

public static int getSplitIndex(java.lang.String s,
                                int nCharPerLine,
                                int lastLineNumber)
        Given a String [s] that is know to be to large for it's Swing Component display
        [via the JPDF], the estimated number of characters per display line
        [int nCharPerLine] and the last display line number [int lastLineNumber] that
        will fit on a JPDF page compute an index [int i] to be used to split the
        given string for satisfactory printer display...

  Kernel usage:
  1)    'JWorkSheetTypeDialog.doPrinter' method when processing the 'JFormForm' Sub-Class
        Information Text, i.e. when building the JTextArea(s) to be printed via
        the JPDF...
        

Parameters:
s - The String to be split...
nCharPerLine - The # of 'char' per line used to estimate the 'wrap' Java functioning...
lastLineNumber - The last display line [int] control...
Returns:
The index [int] to split the given String at...

getStateCodeIndex

public static int getStateCodeIndex(java.lang.String stateCode)

getStateCodes

public static java.lang.String[] getStateCodes()

getStateName

public static java.lang.String getStateName(java.lang.String StateCode)

getStateNameIndex

public static int getStateNameIndex(java.lang.String StateName)

getStateNames

public static java.lang.String[] getStateNames()

getTABIndex

public static int getTABIndex(java.lang.String tabName,
                              java.lang.String[] names)
        Search the given names array [names] for the 'indexOf' occurrence of the
        given TAB Name [tabName]. return the index to the found TAB or a -1 if the
        TAB is not found...

        Kernel Usage:
        1)      'BasejFormTK' abstract class methods that are activated when the 'jFormTK'
                End user uses the 'ALT / n' key combo to seect a 'jFormTK' TAB...

Parameters:
tabName - Tab Name to search for...
names - Array of names to search, i.e. the tabNames String Array...
Returns:
The found index [int] into the 'names' String array...

getTimeStamp

public static java.lang.String getTimeStamp()

getTitledBorder

public static int getTitledBorder(java.lang.String type)
        Return the BorderFactory.titledBorder Justifiation = f(typeIn)...

        Kernel Usage:
        1)      'VerifyABKeyKey.Constructor'...
        

Returns:
'Justification' JFormTKDB String converted to TitledBorder Index [int]...

getTodaysDate

public static java.lang.String getTodaysDate()

getTypeFromString

public static char getTypeFromString(java.lang.String stringType)
        Given the String form of a 'jFormTK' Type Constant [see JConstants Class]
        return the associated 'char' value.

        Kernel Usage:
        1)      'JHDD_IO.JHDD_IO.updateWorkSheet' Method when parsing a
                'JFormFrame.BuildGroup' arguments list.
        

Parameters:
stringType - The 'jFormTK.JConstants' Type String...
Returns:
The matching 'char' parameter...

getSubFolderPath

public static java.lang.String getSubFolderPath(java.lang.String formID)
        Build an path name with the platform separator string in lieu of the
        Form ID DOT character. This String is to be used to construct the
        File System Absolute path from the given Catregory.FileName ID. This
        method is required because the JFormForm Sub-Class files are to be stored in
        folders of the Eclipse Source folder during the 'jFormTK' "Development" stage...

        Kernel Usage:
        1)      'JHDD_IO.updateWorkSheet' method to construct the absolute path to a
                specific JFormForm Sub-Class Java file...
        

Parameters:
formID - Form ID String, i.e. Category DOT File Name ID's
Returns:
The constructed path name String...

getUTC

public static long getUTC(java.lang.String sDateIn)

loadJCouple

public static void loadJCouple(java.lang.String elementsIn,
                               java.lang.String valuesIn)
        This 'Util' method is designed to service a colleection of "Ordered Pairs"
        designed to     set parameters of the current 'JCouple' instance.

        For each element name the following process is performed,
        If the given 'value' is a Null String,
        Then    the JCouple element name value is set from the value of the current
                        'JFormField'...
        Else    the JCouple element name value is set to the non-Null String...

        Kernel Usage:
        1)      ''
        

Parameters:
elementsIn - 'D_ITEMS' delimited set of 'JCouple' element names...
valuesIn - 'D_ITEMS' delimited list of 'JCoupl' values for each 'elements' name...

loadJCouple

public static void loadJCouple(java.lang.String[] elements,
                               java.lang.String[] values)

getUtilityValue

public static UtilValue getUtilityValue(JFormForm form,
                                        java.lang.String source,
                                        java.lang.String from)
        Reference a 'this' Utility Method using the Run Time Assignment prefix ['']...

        This method returns a String Value from the associated 'Util' Function and a
        'jFormTK' Type 'char' in the 'UtilValue' 'jFormTK' Helper Class...

        If the Utility method invoked has a 'void' Method return,
        Then the "|void|" String is returned...

        Kernel Usage:
        1)      'this.assignment' Method although it looks like the 'UtilValue' is
                used only in a DEBUG sysout statement...
        2)      'JValue' Method to service a '' TAG in a 'jFormTK' Assignment String...
        

Parameters:
form - The 'JFormForm' Sub-Class...
source - The Source String, i.e. the Util Method Name and arguments precedded by the '' TAG...
Returns:
The 'UnitValue' instance return designed to return a Value and it's 'JFormField' Type...

getVectorCount

public static java.lang.Integer getVectorCount(java.util.Vector v,
                                               java.lang.String search)
        Get a count of the number of Vector Elements [v] that contain the given
        String [search].

        Kernel Usage:
        1)      'JDocumentation.HistoryFilter.getVisitedFolderNames' method to establish
                a running count of the folder names in the working Vector. This is used
                to count the number of times each folder name is found in the current
                'History' file...
        

Parameters:
v - String vector...
search - String to be found in the given String Vector elements.
Returns:
The computed occurrence count [Integer]...

getVectorSubSet

public static java.util.Vector getVectorSubSet(java.util.Vector v,
                                               int iStart,
                                               int iEnd)

getVerifyFormID

public static java.lang.String getVerifyFormID(java.lang.String anchor)

getWithinBrackets

public static java.lang.String getWithinBrackets(java.lang.String s)
        Return the String found within the "[]" brackes...
        

Parameters:
s - Input String with the "[]" characters...
Returns:
Unpacked String...

idThis

public static java.lang.String idThis(JFormForm form,
                                      JFormField fld,
                                      java.lang.String inputID)

intToBinary

public static java.lang.String intToBinary(int iValue)

intToboolean

public static boolean intToboolean(int iValue)

intToOctal

public static java.lang.String intToOctal(int iValue)

intToString

public static java.lang.String intToString(int iValue)

isActiveField

public static boolean isActiveField(char type)
        Return a boolean Flag if the given 'jFormField' Type is an 'Active Field'...
        NOTE:   An "Active Field" is all Fields except a '_LField' OR a _IField...

        Signatures:
        1)      char Type - used to check the 'jFormTK.JFormField' Type field only...
        2)      JFormField fld - used to check the 'jFormTK.JFormField' Type Field AND to
                ensure that the 'JFormField is Editable..

        Kernel Usage:
        1)      '*this*.getFieldNames' Method...
        2)      '*this*.getJFormField' Method...
        3)      '*this*.deleteGroup' Method...
        5)      'AppForms.buildActiveReturnArray' Method...
        6)      'AppForms.getJFormFieldActiveNames' Method...
        7)      'BasejFormTK.AppFormsTableModel' Method...
        8)      'JFocus.FocusState.getFirstJFormField' Method...
        9)      'JFocus.FocusState.getLastJFormField' Method...
 10)    'JFocus.FocusState.getNextJFormField' Method...
 11)    'JFocus.FocusState.getPreviousJFormField' Method...
 12)    'JFormField.setReferenceValue' Method...
 13)    'JFormForm.getJFormField' Method...
 14)    'JFormFrame.deleteGroup' Method...
 15)    'JFormFrame.onlyIneActiveJFormField' Method...
 16)    'JFormFrame.lastActiveJFormField' Method...
 17)    'JFormFrame.printForm' Method...
 18)    'JFormFrame.setFocusFields' Method...
        

Parameters:
type - 'JFormField' Type control...
Returns:
boolean as a function ot the given Type...

isActiveField

public static boolean isActiveField(JFormField fld)
        Return a boolean Flag if the given 'jFormField' Type is an 'Active Field'...
        NOTE:   An "Active Field" is all Fields except a '_LField' OR a _IField...

        Signatures:
        1)      char Type - used to check the 'jFormTK.JFormField' Type field only...
        2)      JFormField fld - used to check the 'jFormTK.JFormField' Type Field AND to
                ensure that the 'JFormField is Editable...
        3)      'JFocus.doJFormControl' Method...
        4)      'JFormForm.getActiveFormFields' Method...
        5)      'JFormFrame.getJFormFieldIndex' Method...
        6)      'JFormFrame.firstActiveJFormField' Method...
        7)      'FormFrame.firstActiveJFormFieldIndex' Method...
        8)      'JFormFrame'.getNextActiveJFormField' Method...
        9)      'JFormFrame'.getPreviousActiveJFormField' Method...
 10)    'JFormFrame.loadFormFieldVector' Method...
 11)    'jFormIO.showPage' Method...

        Kernel Usage:
        1)      '*this*.firstActiveJFormField' Method...
        2)      '*this*.getPreviousActiveField' Method...
        

Parameters:
fld - 'JFormField' Reference...
Returns:
boolean as a function ot the given Type...

isButton

public static boolean isButton(char type)
        Return a boolean True if the given 'jFormField' Type is a _BField, _AField
        OR _DField...
        

Parameters:
type - 'JFormField' Type [char] Parameter.
Returns:
Boolean as a function of the given 'JFormField' Type char...

isDate

public static java.lang.String isDate(java.lang.String in)

isNumeric

public static boolean isNumeric(java.lang.String in)
        determine if the given String [in] is a numeric field, i.e. a field than
        can be converted to a numeric data type...

        The given string [in] is checked to ensure that the given character are
        numeric or contain the '-','.' or '$' characters...

        If the 'jFormTK' "" prefix exist it is remove prior to the
        numeric evaluation processing.

        Kernel Usage:
        1)      Used several times in various methods of this [Util] Abstract Class...
        2)      'JFormForm.getJFormField' method to process the given 'jFormTK' Field ID's
                set number. NOTE: This may be eliminated since the 'setNumber' currently
                is always a numeric int value...
        3)      Used several more places in the 'jFormTK' Kernel...
        

Parameters:
in - The String to be verified for numeric properties only...
Returns:
A flag [boolean] to indicate numeric [true] or non-numeric String...

isOdd

public static boolean isOdd(int i)

isStringArrayElement

public static boolean isStringArrayElement(java.lang.String searchIN,
                                           java.lang.String[] array)
 Return a boolean flag of truue iff the given search String [searchIn] 
 is found in the given String Array [array]...
 

Parameters:
searchIN - Search String...
array - String Array to be searched for 'searchIn' String...
Returns:
boolean true if the 'searchIn' is found in 'array'...

isStringArrayIndex

public static int isStringArrayIndex(java.lang.String searchIN,
                                     java.lang.String[] array)
 Return an 'int' index of the element of the String Array [array] that matches the given 
 Search String [searchIn]. If no match is made, then return a -1 int value... 
 

Parameters:
searchIN - Search String...
array - String Array to be searched for 'searchIn' String...
Returns:
boolean true if the 'searchIn' is found in 'array'...

isSuffix

public static boolean isSuffix(java.lang.String inString)

keyToString

public static java.lang.String keyToString(int key)

lastNameFirst

public static java.lang.String lastNameFirst(java.lang.String in)

loadDocument

public static void loadDocument(java.lang.String text,
                                javax.swing.text.Document doc,
                                javax.swing.text.SimpleAttributeSet attrs,
                                java.awt.Color color,
                                boolean bold,
                                boolean underline,
                                boolean italics,
                                int fontSize,
                                java.lang.String from)
        Set the "Document" Parameters for the given Sting and load it into the given
        "Document" Object [doc]...

        Kernel Usage:
        1)      'JAddressBook.addressBookEditLAF' method...
        2)      'JFormFrame.setPrompt' method for each [3] 'jLAFControl' mode...
        3)      'NotePad.loadNotePad' method for each [4] String type in the dialog...
        4)      'Util.setStyle' method for each [3] 'jLAFControl' mode...
        

Parameters:
text - Test [String] to be styled...
doc - Document Class instance...
attrs - Document attribute [SimpleAttributeSet]...
color - Foreground text color [Color]...
bold - Bold control [boolean]...
underline - Underline control [boolean]...
italics - Italics control [boolean]...
fontSize - Font Size [int]...
from - DEBUG String annotation...

makeFieldPair

public static java.lang.String makeFieldPair(java.awt.Label label,
                                             java.awt.TextField text)

makeProperName

public static java.lang.String makeProperName(java.lang.String sIn)
        Capitalize the given name and set the remainder of the given name to lower xase.
        If there are multiple words given,
        Then capitalize each word...

        Kernel Usage:
        1)      'JCouple.loadCouple' Method when setting 'owner' OR 'spouse' names...
        2)      'JCouple.setOwner' Method...
        3)      'JCouple.setSpouse' Method...
        

Parameters:
sIn -
Returns:
Constructed String...

makeSerialNumber

public static java.lang.String makeSerialNumber(java.lang.String type,
                                                java.lang.String state,
                                                int nextNumber)

XXXmessage

public static void XXXmessage(java.lang.String title,
                              java.lang.String message,
                              java.lang.String fieldID,
                              boolean styleMessage)
 Display the given message in a 'JMessage' Class dialog.
 NOTE:
 This signature SHALL conditionally perform Message Phrase Styling if
 there is a Non-Null JFormPhrase instance. This signature is used if
 there may be a conflict between the message String and the Style
 parameters.
 
 Kernel Usage:
 1) Used by the 'JMessagePhrase.showJMessagePhrase' method because the display
    shows the Style Parameters in a unacceptable manner for the Style Message processing...
 2) Used various places whenever a Dialog with the 'jFormTK'
    End User is required...

Parameters:
title - Generally this is the 'jFormTK' method name where the message originates from.
message - The message to be presented to the End User.
fieldID - Annotation String if the 'JFormField' Object is not required for new focus...
styleMessage - boolean to control the usage of the 'JMessagePhrase' Style Parameters...

numberOf

public static int numberOf(java.lang.String in,
                           java.lang.String inValue)

objectToString

public static java.lang.String objectToString(java.lang.Object variant)

packCircularArray

public static java.lang.String packCircularArray(java.lang.String[] lastText,
                                                 int lastTextIndex,
                                                 int revertBufferSize)
 Create the 'DynamicReferencingRever' "Save" string. The "Save" String is 
 constructed starting at the element specified by the current 'lastTextIndex' 
 parameter such that when being re-loaded the circular buffer's elements are
 loaded from element zero...
 
 Kernel Usage:
 1) The 'JFormField.toString' Method when the "Revert" Circular Buffer String Array
    [lastText] is to be saved to the Storage Device...
 

Parameters:
lastText - Circular Buffer String Array
lastTextIndex - Next index into the Circular Buffer [int]
revertBufferSize - Number of entries in the Circular Bufver [int]...
Returns:
Packed Circular Buffer String w/ JFormTKDB.itemsDelimiter

packField

public static java.lang.String packField(java.lang.String sIn,
                                         int numberOfCharacters)
        Pack addition '#' characters to ensure that the output is 'NumberOfCharacters'
        long...

        Kernel Usage:
        1)      Not currently used by the 'jFormTK' Kernel...
        

Parameters:
sIn - String to be modified...
numberOfCharacters - Number of Characters [int] in rebuilt string...
Returns:
Revised String...

packField

public static java.lang.String packField(java.lang.String sIn,
                                         char c,
                                         int numberOfCharacters)
        Pack addition character ['c' ]to ensure that the output is 'NumberOfCharacters'
        long...

        Kernel Usage:
        1)      Not currently used by the 'jFormTK' Kernel...
        

Parameters:
sIn - String to be modified...
c - Fill Character [char] to be appended...
numberOfCharacters - Number of Characters [int] in rebuilt string...
Returns:
Revised String...

packFields

public static java.lang.String packFields(java.lang.String[] v)

packFields

public static java.lang.String packFields(java.lang.String[] v,
                                          java.lang.String del)

packFields

public static java.lang.String packFields(java.util.Vector v)

packFields

public static java.lang.String packFields(java.util.Vector v,
                                          java.lang.String del)

packFields

public static java.lang.String packFields(java.util.ArrayList<java.lang.String> aList)

packFields

public static java.lang.String packFields(java.util.ArrayList<java.lang.String> aList,
                                          java.lang.String del)

packItems

public static java.lang.String packItems(java.util.ArrayList<java.lang.String> aList)

packStringVectorToString

public static java.lang.String packStringVectorToString(java.util.Vector v)

packStringVectorToString

public static java.lang.String packStringVectorToString(java.util.Vector v,
                                                        java.lang.String del)

padString

public static java.lang.String padString(int in,
                                         java.lang.String fill,
                                         int n)

padString

public static java.lang.String padString(boolean flag,
                                         java.lang.String fill,
                                         int n)

padString

public static java.lang.String padString(java.lang.String sIn,
                                         java.lang.String fill,
                                         int n)

parse

public static java.util.Vector parse(java.lang.String s,
                                     java.lang.String delimiter)
 Parse a given Sting' [s] into a Vector...
 
 Kernel Usage:
 1) 'JFocusManager.processPrint' Method...
 2) 'JFormWorkSheets.processPrint' Method...
 3) ' NotePad.doPrint' Method...
 

Parameters:
s - String [s] to be parsed...
delimiter - String delimiter for the parse operation...
Returns:
Vector of String's that have been parsed...

parseAssignment

public static java.lang.String[] parseAssignment(java.lang.String inS,
                                                 JFormField fld)
        Parse the given Assignment String [inS] and verify that the individual Assignment 
        parameters are formatted properly...
 
        Kernel Usage:
        1)      '*this*.assignment Method to parse the given Assignment String...
        2)      The following 'JFormField' Methods to verify the Assignment Fields:
                        setPreAssignment     setPostAssignment
                        setPreIf             setPostIf
                        setPreElse           setPostElse
                        setPreIfCondition    setPostIfCondition
        

Parameters:
inS - Assignemtne String...
fld - Host 'JFormField' instance...
Returns:
String Array of Parsed and verified Assignement fields...

parseCondition

public static java.lang.String[] parseCondition(java.lang.String inS,
                                                JFormField sourceFld,
                                                java.lang.String from)
 Parse the Conditional part of a 'jFormTK' Run Time Assignement operation...
 
 Kernel Usage:
 1) *this*.doIfAssignement Method...
 2) JFormField.setPreIF Method...
 3) JFormField.setPostIf Method...
 4) JFormField.setPreIfCondition' to verify the Condition Statement...
 5) JFormField.setPostIfCondition' to verify the Condition Statement...
 

Parameters:
inS - Assignemet Condition String...
sourceFld - 'JFormField' instance for the Host [source] Field...
from - DEBUG annotation of the invoking Class.Method...
Returns:
Parsed String...

prefixToEncodedStringArray

public static java.lang.String prefixToEncodedStringArray(java.lang.String encodedString,
                                                          java.lang.String item)
        "prefix" the given encoded String Array with the given 'item' iff the
        given item is not found in the encoded String Array...

        It is required that the given Encoded String Array [encodedString]
        uses the 'jFormTKDB.getItemsDelimiter' delimiter. If the last character is NOT
        the 'jFormTKDB.getItemsDelimiter' it ia added to the return String...
        

Parameters:
encodedString - Given Encode String Array String
item - Item [String to be added at the start of the return Encoded String...
Returns:
Adjusted Encode String Array...

removeAppCommonDBElement

public static void removeAppCommonDBElement(java.lang.String inName)

replaceInRange

public static java.lang.String replaceInRange(java.lang.String line,
                                              char rangeOpen,
                                              char rangeClose,
                                              char from,
                                              char to)
        Replace a 'char' found within the specifies Range char's.

        Kernel Usage:
        1)      'JHDD_IO.updateWorkSheet' method when a "JFormFrame.BuildGroup" method is
                detected. This method changes the comma delimiters within the Java Array
                syntax with a "^" char so that the "JFormFrame.BuildGroup" fields can be
                parsed using the 'COMMA' char...
        

Parameters:
line - Line [String] to be modified...
rangeOpen - Open 'char' of the Range...
rangeClose - Close 'char' of the Range...
from - 'char' within the Range to be changed...
to - 'char' to change the 'from' character to...
Returns:
Adjusted 'line' String...

replaceBrackets

public static java.lang.String replaceBrackets(java.lang.String line,
                                               java.lang.String brackets,
                                               java.lang.String replacement,
                                               int number,
                                               java.lang.String type)
Replace text found within a set of brackets. Perform "Inclusive" OR "Exclusive" replacements as a function of the given 'type' control parameter. Control the number of replacement as a function of the 'number' int. If 'number' is negative, Then do all replacements operation... Kernel Usage: 1) 'JHDD_IO.updateWorkSheet' method when unpacking the 'buildGroup' Statement. The inner new {} Statements are cleared to enable a Util.unpackToStringArray operation using the comma delimiter...

Parameters:
line - Initial String to be revised...
brackets - Open / Close Bracketrs to delimit the revised text range...
replacement - Value used to replace the Bracketed text...
number - Number of times to do the replacement. If 'number' is -1, Then ALL fields are replaced.
type - "Inclusive" OR "Exclusive" replacement: "Inclusive" means to include the bracketes in the replacement. "Exclusive" means to leave the brackets in the revised string.
Returns:
Revised String...

removeCharacter

public static java.lang.String removeCharacter(java.lang.String in,
                                               char c)

removeCommas

public static java.lang.String removeCommas(java.lang.String in)

removeField

public static java.lang.String removeField(java.lang.String sIN,
                                           java.lang.String field)
        Remove the given String [field] from the given String Input [SIN].
        NOTE:   the Fields Delimiter [D_FIELDS] is used to detect
                        the     current Fields...
 
        Kernel Usage:
        NOT CURRENTLY USED...
        ?)      'JAddressBook.removeFields' to Remove the given 'Anchor' Field from the 
                "Current JAddressBook Entry"...
        ?)      'JAddressBook.removeJFormFields' to Remove the given 'Type' Field from 
                the "Current JAddressBook Entry"...
        

Parameters:
sIN - Input String that contains 'field'...
field - String to be removed from 'sIN'...
Returns:
String after the removal processing

removeField

public static java.lang.String removeField(java.lang.String sIN,
                                           java.lang.String field,
                                           java.lang.String D_FIELDS)
        Remove the given String [field] from the given String Input [SIN]...
 
        NOT CURRENTLY USED...
        ?)      'JAddressBook.removeFields' to Remove the given 'Anchor' Field from the 
                "Current JAddressBook Entry"...
        ?)      'JAddressBook.removeJFormFields' to Remove the given 'Type' Field from 
                the "Current JAddressBook Entry"...
        

Parameters:
sIN - Input String that contains 'field'...
field - String to be removed from 'sIN'...
D_FIELDS - Delimiter [String] used to unpack the 'sIN' Fields...
Returns:
String after the removal processing

removeHighliteSet

public static void removeHighliteSet(java.lang.String formID,
                                     java.lang.String set)
        Remove the specified "HighLite Set" from the indicated 'JFormForm' Sub-Class
        Form...

        Kernel Usage:
        1)      'Util.getUtilityValue' to process a  Reference...
        

Parameters:
formID - 'JFormForm' Sub-Class ID...
set - Set Name [String] to be removed...

removeHighliteSet

public static void removeHighliteSet(java.lang.String formID,
                                     java.lang.String set,
                                     java.lang.String from)
        Remove the specified "HighLite Set" from the indicated 'JFormForm' Sub-Class
        Form...

        Kernel Usage:
        1)      'Util.getUtilityValue' to process a  Reference...
        

Parameters:
formID - 'JFormForm' Sub-Class ID...
set - Set Name [String] to be removed...
from - DEBUG from string for Warning Message annotation...

removeJFormField

public static void removeJFormField(JFormForm form,
                                    java.lang.String id)
        Remove the JFormField [name] from the given 'JFormForm'...

        Kernel Usage:
        1)      Used by the 'jFormTK' developer in the 'JFormForm' SubClass that defines an 
                Application Form. This method is used in an "Action Button" [doButton]
                Override Method OR in a "pre/Post Processor" Override Method when the form is
                to be removed from the current 'JFormForm' SubClass...
        2)      'JTest.showPostProcessor' method when serviving the _QField controls from the
                '_QField.reference' parameter...
        

Parameters:
form - 'JFormForm' SubClass that host the 'JFormField' to be removed...
id - 'JFormField' ID to be removed....

removeJFormFields

public static void removeJFormFields(JFormForm form,
                                     java.lang.String[] ids)
        Remove the JFormField's [Names] from the given 'JFormForm'...

        Kernel Usage:
        1)      'JHDD_IO.removeDefinition' Method...
        1)      Used by the 'jFormIO.removeQuery' Method.
                NOTE:
                The 'jFormIO.removeQuery' method is used in an "Action Button" [doButton] 
                Override Method OR in a "pre/Post Processor" Override Method when the form 
                fields are removed during Run Time...
        

Parameters:
form - 'JFormForm' SubClass that host the 'JFormField' to be removed...
ids - String Array of the 'JFormField' Field ID'S to be removed....

removePercent

public static java.lang.String removePercent(java.lang.String in)

removeSetNumber

public static java.lang.String removeSetNumber(java.lang.String idIn)

removeWhiteSpace

public static java.lang.String removeWhiteSpace(java.lang.String in)
        Remove space characters [white space] from the given String [in]...

        Kernel Usage:
        1)      'JHDD_IO.updateWorkSheet' method when unpacking a String Array line of
                Java code...
        

Parameters:
in - String with white space characters...
Returns:
String with white space removed...

replaceString

public static java.lang.String replaceString(java.lang.String sourceIn,
                                             int offset,
                                             java.lang.String fromIn,
                                             java.lang.String toIn)
        Replace the indicated sub-String [fromIn] with the given sub-String [toIn]
        starting at the specified index [offset] in the given source String [sourceIn].

        Kernel Usage:
        1)      *this*.buildStyledMessage Method...
        2)      *this*.buildStyledPrompt Method...
        3)      'JFormFrame.buildGroup' Method...
        4)      'JMessagePhrase.getPhrasePairs' Method...
        3) 'jFormTK' Application Class's as required...
        

Parameters:
sourceIn - String to be modified...
offset - Byte of 'sourceIn' String to start the edit from...
fromIn - Target String to be replaced...
toIn - Replacement String...
Returns:
Modified 'sourceIn' String...

replaceString

public static java.lang.String replaceString(java.lang.String sourceIn,
                                             java.lang.String fromIn,
                                             java.lang.String toIn,
                                             boolean all)
        Replace the indicated sub-String [fromIn] with the given sub-String [toIn]
        in the given source String [sourceIn].

        If the 'all' Flag is true,
        Then    replace all occurrences of 'fromIn'
        Else    relace the first occurrence of 'fromIn' only...

        Kernel Usage:
        1)      'Util.adjustSetNumber' Method...
        2)      'Util.buildStyledMessage' Method...
        3)      'Util.buildStyledPrompt' Method...
        4)      'AddressBook.init' Method...
        5)      'JarResources.getNames' Method...
        6)      'JarResources.getResources' Method...
        7)      'JarResources.init' Method...
        8)      'JFocus.doPostProcess' Method...
        9)      'JFormField.idThis' to replace 'this' with the host Form ID...
 10)    'JHDD_IO.lookUpReference' Method...
 11)    'JHDD_IO.updateWorkSheet' Method...
 12)    'JWorkSheet.Constructor' Method to add DOT to a JWorkSheet File Name...
 13)    'jFormTK' Application Class's as required...
        

Parameters:
sourceIn - String to be modified...
fromIn - Target String to be replaced...
toIn - Replacement String...
all - Flag [boolean] to control the replacements to be made...
Returns:
Modified 'sourceIn' String...

resetRows

public static void resetRows(JFormForm form)
 Reset the Row numbers in the given forms [form] 'formFields' Vector as a 
 function of the 'JFormField' 'newRow' and 'numberOfRows' parameters...
 
 If a 'formFields' 'JFormField' instasnce has the 'origin' control set to a "R"
 Then ignore it when re4calculating the row numbers...
  
 Kernel Usage:
 1) Used by the 'jFormIO.showPage' Method after a new Vector of 'JFormFields' 
    has been built via the 'jFrame.loadFormFieldsVector' Method. This processing 
    is designed to ensure that the Row Numbers are properly sequenced post any 
    'add' / 'remove' operations by the 'jFormTK' Kernel...
 

Parameters:
form -

reviseString

public static java.lang.String reviseString(java.lang.String inString,
                                            java.lang.String preString,
                                            java.lang.String postString)

secondHalfString

public static java.lang.String secondHalfString(java.lang.String inS)

sequenceSetNumbers

public static void sequenceSetNumbers(JFormForm form,
                                      java.lang.String groupName)

set_AFieldGroupReference

public static void set_AFieldGroupReference(JFormField fld,
                                            java.util.Vector formFields)
        This method is designed to add 'savedJFormField' Strings to the given
        'JFormField' [fld] 'reference' parameter for usage when ALL the 'Group"
        fields have been removed and only the _AField button exist...

        Kernel Usage:
        1)      'JFormFrame.insertField' Method when the _AField button is inserted into the
                'JFormForm'...
        2)      'JFormFrame.addField' Methos iff 'type' = _AField... 
 

Parameters:
fld - 'JFormField' Object to hold the Group saved ToStrings...
formFields - Vector of 'JFormFields' in the Group...

setAssignment

public static void setAssignment(java.lang.String s)

setBit

public static int setBit(int source,
                         int bit)

setColor

public static java.awt.Color setColor(java.lang.String inColors)
        Convert a String computed by the 'Util.getColor' Method to a Java Color Object...

        Kernel Usage:
        1)      Called by the JFormField.Constructor[5]' Method when a given "savedJFormField"
                String is converted to a new 'JFormField' instance...
        

Parameters:
inColors - Encoded Color String...
Returns:
The constructed Color object...

decodeColor

public static java.awt.Color decodeColor(java.lang.String encodedColorIn)
        Produce a Color Java component as a  function of the given "Encoded Color"
        String...
        
        The "Encoded Color" String Format is as follows...
        1.      'cValue' where Value is one of the Java Pre Defined Colors...
        2.      'cRed/cBlue/cGreen' where Red/Blue/Green are the color int value for the
                color to be built.

                If the Red/Blue/Green int values uses the "x" prefix,
                Then the int is considered to be a Hexadecimal quantity...
                EXAMPLES:       'cRed' indicated the Java Color.red object...
                                        'c255/215/0' represent the 'Gold' COLOR...
                                        'cxFF/xD7/x0' is also 'Gold' with Hex Values...

        NOTE:
        If the 'encodedColor' String is Null
        Then a 'null' is returned...

        Kernel Usage:
        1)      'JFormTKDB.JTK.decodeColor' to build the Color Component from a
                'JFormTKDB' Collection element...
        2)      'JLAF.Constructor' to set the Line Border Color from an Encoded Save String...
        3)      Called by the JLAF.set Method to re-set a 'JLAF' Color field from a
                'savedLAF' String...
        

Parameters:
encodedColorIn - Color Encoded Value String...
Returns:
Constructed Java Color component...

decodeFont

public static java.awt.Font decodeFont(java.lang.String encodedFontIn,
                                       java.awt.Font defaultFont,
                                       java.lang.String from)
        Produce a Font Java component as a  function of the given "Encoded Font"
        String...
        
        The "Encoded Font" String Format is as follows...
        1.      'cValue' where Value is one of the Java Pre Defined Colors...
        2.      'cRed/cBlue/cGreen' where Red/Blue/Green are the color int value for the
                color to be built.

                If the Red/Blue/Green int values uses the "x" prefix,
                Then the int is considered to be a Hexadecimal quantity...
                EXAMPLES:       'cRed' indicated the Java Color.red object...
                                        'c255/215/0' represent the 'Gold' COLOR...
                                        'cxFF/xD7/x0' is also 'Gold' with Hex Values...
        Kernel Usage:
        1)      'JFormTKDB.JTK.decodeFont' to build the Font Component from a
                'JFormTKDB' Collection element...
        2)      'JLAF' Constructor when unpacking a Look and Feel encoded String...
        

Parameters:
encodedFontIn - Font Encoded Value String...
defaultFont - default Font used to build the return Font if the xxx values are not present in the Encoded Font String...
Returns:
Constructed Java Color component...

setCurrentAssignmentField

public static void setCurrentAssignmentField(JFormField obj)

setCurrentField

public static void setCurrentField(JFormField fld,
                                   java.lang.String from)
        Set the Current 'JFormField' of the Current 'JFormForm' Sub-Class...

        1)      'JFormField.MouseListener.mouseClicked' to set the Current 'JFormField' to
                the "Clicked" Field...
        

Parameters:
fld - Current 'JFormForm' Sub-Class 'JFormField' instance reference...
from - DEBUG String to indicate the referencing 'jFormTK' Method...

setFont

public static java.awt.Font setFont(java.lang.String inFonts)

setFontEncoded

public static java.awt.Font setFontEncoded(java.lang.String encodedFont,
                                           java.lang.String from)
 Produce a Font object as a function of the given "Encoded Font" String in the following Format:
 
 "fnn~ss~ll~" where 
 'nn' represent the Font's Name, 
 'ss' is the Font Style Control Strings and 
 'll' is a String that contains the Font Size.
 
 NOTE: 8/23/2003
 The Style parameter may be either a Style Constructed from a Ascii String by the Software 
 Developer [e.g. BOLDUNDERLINE] or a "packed" Style Constructed for a 'savedLAF' String 
 using the 'Util.getFontEncoded' Method. The "packed" Style is annotated via the 
 'jFormTKDB.getFontStylePrefix' Character in the 1st Character of the Style String...
 
 Kernel Usage:
 1) Called by the JLAF set Method to Set a 'JLAF' Font  given a Encoded String field from 
    a 'savedLAF' String...
 2) Called by the 'JLAF,Constructor' to create a local Font as a function of the Font
    String unpacked from the 'encodedJLAF' String...
 

Parameters:
encodedFont - String of Encodeed Font Parameters...
Returns:
Font constructed from the 'encodedFont' String...

setJFormFieldMark

public static void setJFormFieldMark(JFormForm form,
                                     JFormField refField)
        Set the given Field [refObj] of the specified Form [form] as a "Marked" Field
        for "QuickEdit" availability...

        Kernel Usage:
        1)      Called by the 'addressBook.doRemove' Method when a matched Name is reset as
                a function of the 'Reruired Field' Flag as part of a "Remove Name From the
                Address Book" processing. The modified field is automatically added to the
                current "Quick Edit" items so that the End User can easily Navigate the
                field for a future "Edit" operation...
        

Parameters:
form - Host 'JFormForm' Sub-Class...
refField - 'JFormField' instance to adjust...

setHighliteLAF

public static void setHighliteLAF(java.lang.String formID,
                                  java.lang.String setName,
                                  java.lang.String encodedJFormFieldLAF,
                                  java.lang.String rangeIn,
                                  java.lang.String processControl,
                                  java.lang.String exitFlowControlIn,
                                  java.lang.String exitProcessingControl,
                                  java.lang.String from)
        Set the 'highliteControls' for the 'JFormForm' Sub-Class specified in the
        given 'range' parameter as defined by the 'setName', 'lafs' and 'range'
        parameters...

        If the given Encoded LAF String [encodedLAF] is the Null String,
        Then set the indicated [by 'componentID'] Component LAF to 'null'...
        

Parameters:
formID - The 'JFormForm' Sub-Class ID to host the Highlite Controls...
setName - The SetName String used to TAG each unique 'highliteControl' Set...
encodedJFormFieldLAF - 'JFormFiledLAF' String used to produce the working instance...
rangeIn - String with the Start / Stop 'JFormField' ID's OR a 'jFormTK' Group Name...
processControl - Process Control ["ON", "OFF", "REMOVE" or "ASIS"...
exitFlowControlIn - Exit 'flowControl' Value String...
exitProcessingControl - Exit Processing Control Value String...
from - DEBUG String annotation...

setFormLAF

public static void setFormLAF()
        Reset the current Form's Look and Feel Parameters as a function of the current
        'JFormTKDB' Collection Elements. The Form Elements that may be reset by this
        method are as follows:
                -       buttonPanelLAF
                -       controlButtonLAF
                -       formPanelLAF
                -       hintLAF
                -       hintDisclaimerLAF
                -       hintTextPanelLAF
                -       promptLAF
                -       showPanelLAF

        NOTE:
        I have no way currently to change during Run-Time the Tab Panel Selection LAF...
        The LAF is set during initialzation using the Java UIManager. I tried to
        reissue the call to UIManager for "TabbedPane.selected" in this method but
        no change was produced???       11/1/2006...
 
        Kernel Usage:
        1)      'JHDD_IO.showPage' Method to refresh the page when a new 'JFormForm' Sub-Class
                is loaded OR when a re-load of a Form whose data has been modified occurs...
        


setSetNumberWildCard

public static java.lang.String setSetNumberWildCard(java.lang.String id)
        Set the Set Number field of a given 'jFormTK' Form ID to the 'jFormTK' Set Number 
        Wild Card...

        Kernel Usage:
        1)      'JFormField.updateAddressBook' Method iff the host 'JFormField' is within a
                Group... 
        

Parameters:
id - 'jFormTK' ID String...
Returns:
Constructed ID with Wild Card replacement...

setStyle

public static void setStyle(javax.swing.JTextPane tp,
                            java.lang.String annotation)
        Set the Style Parameters of the given 'JTextPane' [tp] as a function of the
        given message [annotation] and the 'AppDB.JMessagePhrase' parameters. If the
        'AppDB.JMessagePhrase' is null, just load the 'JTextPane' with the
        unstyled 'annotation' String...
 
        Kernel Usage:
        1)      jFormTK.JMessage Class to format message pre Dialog Display...
        2)      JFormFrame.NonNullDialog Method to display Save / Non-Save Dialog...
        

Parameters:
tp - JTextPane to host the Styled 'annotation' String
annotation - The message to be displayed in the JTextPane post style procxessing.

setStyle

public static void setStyle(javax.swing.JTextPane tp,
                            java.lang.String annotation,
                            JLAF messageLAF)
        Set the Style Parameters of the given 'JTextPane' [tp] as a function of the
        given message [annotation] and the 'AppDB.JMessagePhrase' parameters. If the
        'AppDB.JMessagePhrase' is null, just load the 'JTextPane' with the
        unstyled 'annotation' String...
 
        Kernel Usage:
        1)      jFormTK.JMessage Class to format message pre Dialog Display...
        2)      JFormFrame.NonNullDialog Method to display Save / Non-Save Dialog...
        

Parameters:
tp - JTextPane to host the Styled 'annotation' String
annotation - The message to be displayed in the JTextPane post style procxessing.
messageLAF - JLAF for the "Message" [non-Phrase] Look and Feel...

setStyle

public static void setStyle(javax.swing.JTextPane tp,
                            java.lang.String annotation,
                            JLAF messageLAF,
                            JLAF messagePhraseLAF)
        Set the Style Parameters of the given 'JTextPane' [tp] as a function of the
        given message [annotation] and the 'AppDB.JMessagePhrase' parameters. If the
        'AppDB.JMessagePhrase' is null, just load the 'JTextPane' with the
        unstyled 'annotation' String...
 
        Kernel Usage:
        1)      jFormTK.JMessage Class to format message pre Dialog Display...
        2)      JFormFrame.NonNullDialog Method to display Save / Non-Save Dialog...
        

Parameters:
tp - JTextPane to host the Styled 'annotation' String
annotation - The message to be displayed in the JTextPane post style processing.
messageLAF - JLAF for the "Message" [non-Phrase] Look and Feel...
messagePhraseLAF - JLAF for the "Phrase" Look and Feel...

setText

public static void setText(java.lang.String anchor,
                           java.lang.String text,
                           java.lang.String from)
        Set the 'JFormField' Text Value indicated by the given 'jFormTK' anchor to the
        provided [text] String...
        
Kernel Usage: 1) 'AddressBook.doResetName' Method when the 'jFormTK' End User opts to change the name of a 'JAddressBook' Entry. This method uses the 'JAddressBook' Entry "Anchor" to change the value, i.e. the Name content in the indicated Application form [JFormForm]...

Parameters:
anchor - 'JAddressBook' Anchor [String]...
text - Value to set the text to [String]...

show

public static void show(java.lang.String message,
                        java.lang.String type,
                        java.lang.String from)
        This is a general purpose 'show' display method designed for usage with the
        'JProperties' dynamic debug capability. The 'debug' Property shall include a
        'type' String as follows:

        'type' = "fyi"          -       Display the message in a JFormFrame.fyi Dialog...
        'type' = "fyiecho"      -       Display the message in a JFormFrame.fyi Dialog and
                                                        Echo the message to the Java Console...
        'type' = "echo"         -       Echo the message to the Java Console ONLY...
        

Parameters:
message - Message String to be shown...
type - Control 'type' described above...
from - From String annotation...

showFocus

public static void showFocus(java.lang.String annotation)
This method is designed to show in the Java Console [via System.out.println] the current Focused Window Name and the Focus Owner Name. NOTES: 1) The active Window is always either the focused Window, or the first Frame or Dialog that is an owner of the focused Window. Only a Frame or a Dialog can be the active Window 2) The focused Window is the Window that is, or contains, the focus owner 3) The focus owner is the Component that receives key events. The focus owner is either the currently focused window or a component within this window... The display is appended with the given 'annotation' String...

Parameters:
annotation - String annotation to be appended to the display...

showFormFields

public static void showFormFields(JFormForm form,
                                  java.lang.String from)

showFormFields

public static void showFormFields(JFormForm form,
                                  java.lang.String from,
                                  boolean debug)

showFormFields

public static void showFormFields(JFormForm form,
                                  java.util.Vector formFields,
                                  java.lang.String from)

showFormFields

public static void showFormFields(JFormForm form,
                                  java.util.Vector formFields,
                                  java.lang.String from,
                                  boolean debug)

showIntArray

public static void showIntArray(java.lang.String heading,
                                int[] array)

displayStringArray

public static java.lang.String displayStringArray(java.lang.String heading,
                                                  java.lang.String[] array)

showStringArray

public static void showStringArray(java.lang.String heading,
                                   java.lang.String[] array)

showStringVector

public static void showStringVector(java.lang.String heading,
                                    java.util.Vector v)

showThread

public static void showThread(java.lang.String prefix)

showThreadName

public static void showThreadName(java.lang.String prefix)

displayVectorToString

public static java.lang.String displayVectorToString(java.lang.String annotation,
                                                     java.util.Vector v,
                                                     java.lang.String prefix,
                                                     int nTruncate)

showVector

public static void showVector(java.lang.String annotation,
                              java.util.Vector v,
                              java.lang.String prefix,
                              int nTruncate)

softAbort

public static void softAbort(java.lang.String location,
                             java.lang.String summary)
 Use the 'JSoftAbort' Class to display a "Fatal" Error Message to the 
 'jFormTK' Developer...
 
 Kernel Usage:
 This method is a DEBUG method designed for usage by the 'jFormTK' Kernel
 to abort the execution of their Appso that detected setup errors may be
 identified and corrected.
 
 NOTE:
 The 'JSoftAbort' Class is designed to save any data that is available and deemed
 necessary for the next execution of the application. This error should never occur
 when the App is in distribution but all saveable data is saved in case the error
 does occur durring the "Deployment" Software Development Phase...
 

Parameters:
location -
summary -

stringArrayToString

public static java.lang.String stringArrayToString(java.lang.String[] array,
                                                   java.lang.String del)

stringToAmount

public static java.lang.String stringToAmount(java.lang.String in)

stringToboolean

public static boolean stringToboolean(java.lang.String in)

stringToChar

public static char stringToChar(java.lang.String in)

stringTofloat

public static float stringTofloat(JFormField fld)

stringTofloat

public static float stringTofloat(java.lang.String in)

stringToInt

public static int stringToInt(JFormField fld)

stringToInt

public static int stringToInt(java.lang.String in)

stripQuotesString

public static java.lang.String stripQuotesString(java.lang.String sIn)

suffixToEncodedStringArray

public static java.lang.String suffixToEncodedStringArray(java.lang.String encodedString,
                                                          java.lang.String item)
        Add to the given encoded String [encodedString] the given 'item' [item] iff
        the given item is not found in the encoded String Array...

        Each item in the encoded String uses the JFormTKDB.itemsDelimiter by definition.
        If the given item is NOT in the encoded String than the return String SHALL
        consist of the encoded String PLUS the 'item' PLUS the JFormTKDB.itemsDelimiter...

        If the JFormTKDB.itemsDelimiter is NOT the last character of the encoded String,
        Then it is added automatically...

        Kernel Usage:
        1)      Various Developer Methods to dynamically modify an array of String items
                used in Choice List...
        

Parameters:
encodedString - String of encoded values for the base return String...
item - String to be added to 'encodedString' iff it is NOT found in the base String [encodedString]...
Returns:
The adjusted base String...

syncSetNumber

public static java.lang.String syncSetNumber(java.lang.String inID,
                                             int setNumber)

toItemsDelimiterString

public static java.lang.String toItemsDelimiterString(java.lang.String s,
                                                      java.lang.String del)
        Convert the given String of items [s] with the given delimiter [del] to a String
        of items with the 'jFormTKDB' Items Delimiter...

        Kernel Usage:
        1)      NO 'jFormTK' Kernel Usage...
        

Parameters:
s - String to be converted.
del - Given String [s] delimiter...
Returns:
Translated String with 'jFormTKDB' Items Delimiter...

toCaps

public static java.lang.String[] toCaps(java.lang.String[] strings)
        Convert each element of the given String Array to a capital letter followed by
        all lowercase characters...
        

Parameters:
strings - String Array of elements to be converted...
Returns:
The reconstructed return String Array...

toCaps

public static java.lang.String toCaps(java.lang.String s)

unpackFieldName

public static java.lang.String[] unpackFieldName(java.lang.String fieldName)

unpackFields

public static java.util.Vector unpackFields(java.lang.String sIN)

unpackFields

public static java.util.Vector unpackFields(java.lang.String sIN,
                                            java.lang.String del)

unpackFormName

public static java.lang.String[] unpackFormName(java.lang.String formName)

unpackKeyWords

public static java.lang.String[] unpackKeyWords(java.lang.String keyWords,
                                                boolean debug)
        Unpack the given Key Words String [keyWords] into a String Array implementing the
        following Syntax rules:

        1)      Key words are delimited with the space character.
        2)      Mult-Word Key Words are surrounded by double quotes [""]...

        The method is designed to correct Key Word String that are ill formed and an
        error warning is presented if the Key Word String has unbalanced quotes.

        If a warning dialog is presented OR if the Key Word String is the 'Null'
        String an empty String array is constructed. The calling method SHALL check for
        the empty String Array and request another Key Word String from the End User...

        Kernel Usage:
        1)      'JDocumentation.SelectSearchItem.doFind' method to process Key Words
                given in the Dialog's '' Text Area...
        

Parameters:
keyWords - Key Words String from 'JDocumentation.SelectSearchItem' 'keyWords' Text Area.
debug - DEBUG flag [boolean]
Returns:
String Array of the Unpacked 'keyWords' String...

countNumberOfGivenCharacter

public static int countNumberOfGivenCharacter(java.lang.String s,
                                              char c)
        Return a count [int] of the number of characters [c] in the given String [s]...
        Kernel Usage:
        1)      'Util.unpackKeyWords' method to check the Key Word String for unbalanced
                double quote characters...
        

Parameters:
s - Input String to be checked...
c - The character to be counted...
Returns:
The int count of 'c' occurrences in 's'...

unpackQuotePhrases

public static java.lang.String[] unpackQuotePhrases(java.lang.String s)

unpackToIntArray

public static int[] unpackToIntArray(java.lang.String sIN)

unpackToIntArray

public static int[] unpackToIntArray(java.lang.String sIN,
                                     java.lang.String del)

unpackToStringArray

public static java.lang.String[] unpackToStringArray(java.lang.String sIN)

unpackToStringArray

public static java.lang.String[] unpackToStringArray(java.lang.String sIN,
                                                     java.lang.String del,
                                                     java.lang.String from)
        Unpack the given String [sIN] using the given token Delimiter [del].
        Place the unpacked tokens into a String Array...

        Kernel Usage:
        NOTE:
        This method is used liberally thru the 'jFormTK' Kernel.
        Therefore it is important that it be as efficient as possible.
        In March 2007 I rewrote it using the private 'split' method that uses the
        'StringTokenizer' appraoch. After doing some timeing analysis [using the
        'elapsedTime' private method I concluded the original Parse method was
        "Generally" faster. The 'elapsedTime' method get the time in milliseconds and
        calculated the elapsed time as zero. I then looped the timed code in loops of
        1000 to get any elapsed time > 0.

        I also tried the JDK 1.4 String.Split method to accomplish the required task.
        This failed because I could not devise a regular expression for 'split' that 
        serviced the "Missing Token" problem [i.e. sIN = "A,B,,D" return ["A", "B" , "D"]
        array rather than the required ["A", "B" , "", "D"] array.

        Bottom Line:
        JDK 1.5 supposidely has a method that solved the problem but the "Parse" times look
        good and probably not worth the above effortds...
        
        

Parameters:
sIN - Input String to be unpacked...
del - The delimiter [String]...
Returns:
String Array of unpacked tokens...

unpackToStringArray

public static java.lang.String[] unpackToStringArray(java.lang.String sIN,
                                                     java.lang.String del)

unpackVerifyFormID

public static java.lang.String[] unpackVerifyFormID(java.lang.String anchor,
                                                    java.lang.String from)

unpackVerifyID

public static java.lang.String[] unpackVerifyID(java.lang.String id,
                                                java.lang.String from)
        Construct a String array that contains the following elements from the given
        'jFormTK' ID String:
                [0]     -       Category
                [1]     -       FileName
                [2]     -       Group Name
                [3]     -       Field Name
                [4]     -       Set Number
        Note:
        If a field is NOT verified,
        Then leave the associated return String element equal to a null, i.e. ""...

        Kernel Usage:
        1)      'this.adjustSetNumber' Method to Verify the Given Reference ID...
        2)      'this.assignment' Method to verify an "Assignment Branch"  ID...
        3)      'this.findJFormFieldInFormFields' Method to get the matching Group Name and
                field name from a given 'jFormTK' ID...
        4)      'this.fyiItems' Method to verify the given Dynamic Reference...
        5)      'this.getJFormForm' Method to verify the given 'JFormForm' Sub-Class ID...
        6)      'this.getVerifiedFormID' Method to verify a Form ID before repacking it with
                the 'jFormTK' ID parameters derived from this Method...
        7)      'this.getVerifyFormID' Method to verify a Form ID before repacking it with
                the 'jFormTK' ID parameters derived from this Method...
        NOTE:   Hard to tell the difference between 'getVerifiedFormID' and 'getVerifyID'???
                        Need to take the time, sometime, to evalute usages and test results.
                        JEC 8/24/05
        8)      'this.setSetNumberWildCard' to verify the given ID before adjusting the set number...
        9)      'this.getVerifiedFieldID' to verify the given Field ID...
        10)     'AddressBook.doGoToForm' Method...
        11)     'AddressBook.Type_AnchorDialog.Constructor'...
        12)     'AppForms.getJFormForm' Method...
        13)     'appForm.getValue' Method...
        14)     'AppForms.setValue' Method...
        15)     'AppForms.getJFormField' Method...
        16)     'AppForms.getWS' Method...
        17)     'BasejFormTK.QuickEditDialog.doEdit' Method...
        18)     'BasejFormTK.QuickEditDialog.doGoTo' Method...
        19)     'JAddressBook.doGoToForm' Method...
        20)     'JFocus.doUpdateAddressBook' Method...
        21)     'JFormForm.isGroup' Method...
        22)     'JFormFrame.doUpdateAddressBook' Method...
        23)     'JValue.Constructor' to determine if the given source is a 'jFormTK' ID...
        24)     'JValue.Constructor' when the source has NOT indicated a 'JFormField' in
                the current 'JFormForm' Sub-Class. The given source is then unpacked
                using this method to attempt to get a new 'JFormForm' Sub-Class reference...
        

Parameters:
id - 'JFormTK' ID. Minimum of a field name from the current 'JFormForm' Sub-Class required...
from - DEBUG from String...
Returns:
String array of constructed 'jFormTK' ID parameters as outlined above...

vectorToIntArray

public static int[] vectorToIntArray(java.util.Vector v)

vectorToObjectArray

public static java.lang.Object[] vectorToObjectArray(java.util.Vector v)

vectorToStringArray

public static java.lang.String[] vectorToStringArray(java.util.Vector v)

XXXgetjFormInfo

public static JFormInfo XXXgetjFormInfo()

XXXincrementRows

public static int XXXincrementRows(int iStart,
                                   int iDelta,
                                   JFormForm form)

XXXputjFormFrame

public static void XXXputjFormFrame(JFormFrame f)

XXXunpackVerifyFieldName

public static java.lang.String[] XXXunpackVerifyFieldName(java.lang.String fieldName)