com.jFormTK
Class JDoc

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

public class JDoc
extends java.lang.Object
implements JConstants

        This class is designed to automate the 'jFormTK' Framework "Controls" TAB
        "Documentation" button that presents a collection of image files designed to provide
        an In-Application Users Guide.

        There are five Java TreeMap's designed to service the 'JDocumentation' Class
        request as the 'jFormTK' End User Cycles thru the Documentation slides [images]...
        The TreeMap's are as follows:
        1)      'jDocScriptControls':
                -       Constructed = f[JDoc Script]...
                -       Unique TreeMap Key for each Book, Chapter and Section of the JDocumentation
                        Framework...
                -       The TreeMap Value object is an Object Array as follows:
                                [0]     -       'Book' OR 'Chapter' OR 'Section' jDocControls' Location KEY...
                                [1]     -       Image Folder Location..
                                [2]     -       Image Folder Name...
                                [3]     -       Image Folder Label...
                                [4]     -       Image Folder Synopsis / Key Word Data...
                NOTE 1: Element [0-4] are Strings that control the Tab Annotations.
                                These elements are fetched via the 'getValues' Method...
        2)      'orderControls':
                -       If NOT null, then the image order is controlled by the values list [below]...
                -       Contains an element for each 'jDocScriptControls' element...
                -       The TreeMap Key is the Image Folder Name for each Book, Chapter, Section...
                -       The TreeMap 'Value' is a variable length String Array with each element
                        containing a URL for an image to be displayed. The images are displayed in the
                        order they appear in this TreeMap value String Array.
                NOTE 1: The image URL may be just an image file name from the associated
                                Image Folder / Sub Image Folder OR Sub Sub Image Folder HDD Folder name
                                [e.g. img012.gif] OR a FULL reference to a different Book / Chapter OR
                                Section HDD Folder [e.g. Info\About\img011.gif]...
                NOTE 2: This values String Array may be derived from the 'Order.txt' file iff
                                a Folder Name is enclosed in parens in the JDoc Script...
                NOTE 3: This values String Array may be derived from the "Order Clause" syntax
                                [OC:] of the JDoc Script...

        3)      'overrideControls':
                -       An "Override" is a command in the JDoc Script that states that ALL
                        references to an associates Images Folder shall come from the
                        1st Tier that contains images for that Images Folder. It is generally
                        used when images are provided in the HDD Tier. In that case, if there
                        are images in the HDD file for the associates Images Folder, then no image
                        files shall be used from the Application Images OR 'jFormTK' Kernel
                        Images Tier.
                -       This [overrideControls] TreeMap is designed to control which images Tier
                        an images file shall be derived from. It is used in the
                        'JDoc.createDocumentationFiles' to control which Tier to be inserted into
                        the 'imageControls' TreeMap...
                -       Constructed by the 'buildOverrideControls' Method = f[jDocScriptControls].
                        If an Override Control is found in the 'jDocScriptControls',
                        Then an entry is made into the 'overrideControls' and the override
                        reference is removed from the 'jDocScriptControls'...
                The TreeMap Key is the 'JDoc' Location KEY [i.e. Book|Chapter|Section]...
                The TreeMap Value is a String with the Image Folder Location and the State Code.
                The Items Delimiter is used as the delimiter.
                The State Code is initialized to "U" [Undefined].
                It is set to "H" if the "Override" image file exist on the HDD OR to "A"
                if the "Override" image file SHALL be found in the Application Images JAR file.
                NOTE 1: The State Code is used to identify which Images Tier contains each
                                required image file...
                NOTE 2: The "Override" 'jFormTK' feature enforces the following rule:
                                Use the image files from the first Image Files Tier and ignore
                                any image files from the higher Image Files Tiers. This is
                                implemented in the 'JDoc.createDocumentationFiles' Method so that the
                                image files to be ignored are NOT placed into the 'imageControls'
                                TreeMap...
                                        
                                This 'jFormTK' feature is generally used to force the usage of image
                                files in the 'HDD' images folder and to ignore the folder image files
                                that exist in the 'jFormTK' Application Images JAR or the 'jFormTK'
                                Images JAR file.

                                This "Override" feature is NOT required if the image files on the HDD
                                have the same file names as the 'jFormTK' Application Images JAR or
                                the 'jFormTK' Images JAR file because the Image Tier processing gives
                                preference to HDD files.

                                This 'jFormTK' Feature is designed to allow the 'jFormTK' Application
                                developer the ability to produce and insert his / her own Documentation
                                image files without having to be concerned about the image file names
                                existing on either Images JAR files.

                NOTE 3: If the 'jFormTK' Override feature is not used,
                                Then the Image Files Tier Processing is implemented and files are taken
                                in HDD, Application Images Jar and 'jFormTK' Images JAR order. They,
                                by default, are displayed in alphabetical file name order. One could add
                                additional image files [slides] to the Documentation Presentation by
                                judicially naming the image file insert and placing it temporarily in
                                the appropriate HDD image folder.

                                For example, if you wanted to insert a slide between image files
                                "images\UserGuide\FindEdit\Edit\img005.jpg" and
                                "images\UserGuide\FindEdit\Edit\img006.jpg" you would name the new
                                image file "img005A.jpg" and place it in the
                                "images\UserGuide\FindEdit\Edit\" folder on your development HDD.

                                Before deployment you would produce your Application Images JAR file
                                with the inserted file(s) included. Upon deployment you would NOT
                                create an "images\UserGuide\FindEdit\Edit\" HDD folder. Therefore,
                                the 'jFormTK' Kernel will find the required Documentation file on the
                                Application Images JAR [first] and then in the 'jFormTK' Images JAR
                                file.

                NOTE 4: "Order Claues" Feature:
                                Another 'jFormTK' methodology designed to control the image slides to
                                be displayed and their presentation order is the usage of the 'jFormTK'
                                "Order Clause" Feature. As the Documentation image files are collected
                                for processing they are derived from the Image Tier as a f[JDoc Script]
                                or as a f["Order Clause"]. If an "Order Clause" exist, then the order
                                clause parameters specify the image files to be used and their
                                presentation order, i.e. the image slides are presented by the
                                'jFormTK' Kernel in the order they are found in the "Order Clause".

                                If only the image file name is given, then the file is assumed to be in
                                the "Image Folder" name provided in the JDoc Script. If the file
                                description includes a FULL folder name, then it is used to retrieve
                                the image file using the Images Tier Logic. This allows the 'jFormTK'
                                Developer to select images from different images Folders.

                                If the image file name has an "A:" prefix,
                                Then the image file is taken from the Application Images JAR file.

                                If the image file name has a "J:" prefix,
                                Then the image file is taken from the 'jFormTK' Images JAR file.

                                If the image file name has a "H:" prefix,
                                Then the image files is taken from the HDD images Folders.
                                The "H" prefix is the default and therefore not required. It was
                                included to make the reading of the JDoc Script more intuitive.
                                If used and the specified image file is not found in the specified HDD
                                folder, a warning message is produced to inform the 'jFormTK' Developer
                                of a image file setup problem.

                                An "Order Clause" is entered in the follow manners:
                                1)      Included in the JDoc Script using the "OC" syntax.
                                        See the 'jFormTK.Main.loadJDocScript' DOC file...
                                2)      From an "Order.txt" file found in an "Order" sub-folder to any of
                                        the HDD images Chapter OR Section folders.

        4)      'imageControls':
                -       Contains an element for each image file to be used by the 'jFormTK' Kernel...
                -       Derived by the 'JDoc.createDocumentationFiles' Method...
                -       The TreeMap KEY is the image File Name...
                -       The TreeMap Value is a 'JImageControl' JDoc Inner Class [JImageControl]
                        designed to     hold the Image File Key, the imageType, the image extension,
                        and the img reference...
                NOTE 1: The image Type [int] to indicate which Image Field Tier to fetch the
                                Image From iff the 'img' reference is 'Null'...
                                The acceptable values are as follows:
                                0       -       'HDD' images Folders...
                                1       -       'applicationImagesJAR'...
                                2       -       'jFormTKImagesJar'...
                NOTE 2: If an image is requested, the 'img' reference is returned if it is
                                NOT 'Null' OR it is derived = f[imageType], set in the 'img' reference
                                and returned to the envoking process...

        5)      'synopsisControls':
                -       This TreeMap has an entry for each JDoc Slide Set. It is used by the
                        Documentation 'Search' function. If a key Word is found in a 'Synopsis'
                        String by the 'Documentation.doFind' method a found item is found that
                        points to the associated Slide Set [=f[locationKEY] and slide number 0...
                -       The TreeMap Key is the 'JDoc' Location KEY [i.e. Book|Chapter|Section]...
                -       The TreeMap Value is the 'synopsis' String from the 'JDoc' Script
                        converted to Lower Case...
        
        Kernel Usage:
        1)      Hosted by the Application Data Base [AppDB] and instanced by the 'AppDB.initialize'
                method...

        

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

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

Field Summary
(package private)  java.awt.Toolkit toolkit
           
 
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, 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, pCheckboxGroup, QUOTE, SPACE_, TAB, YES
 
Constructor Summary
JDoc()
          Constructor
 
Method Summary
static void buildJDocScriptControls(java.util.Vector v)
           Build the 'JDoc.jDocScriptControls' TreeMap as a function of the 'jFormTK' Kernel Default 'JDoc' Documention Script.
 void createDocumentationFiles()
           This method is designed to create the 'imageControl' TreeMap that shall contain an element for each Image File to be used by this 'jFormTK' Application.
static java.lang.String displayJDoc(boolean debugGetImages)
           
static java.lang.String displayJDocScriptControls(java.lang.String title, boolean full)
           Produce a formatted display [String] of the 'JDoc.jDocScriptControls' instance.
static java.lang.String displayOrderControls(java.lang.String title, boolean showNonNull)
           
static java.lang.String displaySynopsisControls(java.lang.String title)
           
static java.util.Vector findImagesFolder(java.lang.String tabFolder)
           
static java.lang.String[] findSynopsis(java.lang.String[] searchKeyWords)
           
static java.lang.String[] getBookItems()
           
static java.lang.String[] getChapterItems(int bookIndex)
           Return a String Array of the 'Chapter' Controls for the given 'Book'...
static java.lang.String getFileName(java.lang.String key, int fileNumber, java.lang.String from)
           Return a String that contains the File Location and the file retrieval 'doCase'.
static java.lang.Object[][] getImageFiles(javax.swing.JProgressBar pb, java.lang.String locationKEY)
           Return an Object array of the following Ordered Paits: 1) File Name [String] 2) Image File [ImageIcon] that match the given Location KEY...
static javax.swing.ImageIcon getImageIcon(java.lang.String fileName)
           Return an 'ImageIcon' for the given 'fileName'...
static java.util.Vector getImages(java.lang.String searchPath)
           Construct a Vector of all the images in the 'JDoc.imageControls' TreeMap...
static java.util.TreeMap getJDocScriptControls()
           Return the current 'jDocScriptControls' TreeMap...
static java.lang.String getLabel(int book, int chapter, int section)
           This method is designed to return the 'Label' Field of the indicated TAB Field...
static int getNumberOfBooks()
           This method is designed to return the Number of unique Tab's in the current 'JDoc' instance...
static int getNumberOfChapters(int bookIn)
           This method is designed to return the Number of unique Sub Tab's for the given Tab index [tab] of the current 'JDoc' instance...
static int getNumberOfSectionFiles(java.lang.String key, java.lang.String from)
           This method is designed to return the Number of Image Files associated with the given Documentation Book / Chapter / Section...
static java.lang.String[] getSectionItems(int bookIndex, int chapterIndex)
           Return a String Array of the 'Section' Controls for the given 'Book' and Chapter...
static java.util.TreeMap getSynopsisControls()
           Return the 'synopsisControls' Tree Map instance...
static java.lang.String getTabLabel(java.lang.String locationKey)
           
static java.util.Vector getTabParameters(java.lang.String tabType)
           Produce a Vector that contains the specified elements of the 'jDocScriptControls' instance.
static java.lang.String[] getValues(java.lang.String key, java.lang.String from)
           Return the Values String Array = f[tabControls Key] indexes...
static boolean isJDocScriptControls(java.lang.String key)
           Return a boolean of true iff the given key is in the 'jDocScriptControls'...
static java.util.Vector overrideTab(java.lang.String tabName)
           Utility method designed to add the "Override" controls to a Tab Name of the 'JDoc.jDocScriptControls' instance...
 void putImageControls(java.lang.String key, int imageType, java.lang.String extension, javax.swing.ImageIcon img)
           Place an entry into the 'JDoc.imageControls' TreeMap...
static void showImageControls(java.lang.String title)
           Present a dialog that list all the 'jFormTK' Image File Names and a column that illustrates the file source of each Image File, i.e.
static void showJDocScriptControls(java.lang.String annotation)
           
static void showOrderControls(java.lang.String annotation)
           Display the current content of the 'JDoc.orderControls' Tree Map...
static void showOverrideControls(char mode)
           Show the 'JDoc.tierControl' TreeMap...
static void showSynopsisControls(char mode, java.lang.String from)
           Show the 'JDoc.synopsisControl' TreeMap...
static int XXXfindValues(java.lang.String[][] values, java.lang.String key)
           
static java.lang.String[] XXXgetSectionItems(int bookIndex, int chapterIndex, int sectionIndex)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

toolkit

java.awt.Toolkit toolkit
Constructor Detail

JDoc

public JDoc()
Constructor

Method Detail

buildJDocScriptControls

public static void buildJDocScriptControls(java.util.Vector v)
        Build the 'JDoc.jDocScriptControls' TreeMap as a function of the
        'jFormTK' Kernel Default 'JDoc' Documention Script.

        Kernel Usage:
        1)      'Main.loadJDocScript' Method or it's jFormTK Application Override
                method after a Vector has been created in the 'JDoc' Documentation
                Script format...
        

Parameters:
v - Vector of String elements in the JDoc Script Format...

createDocumentationFiles

public void createDocumentationFiles()
        This method is designed to create the 'imageControl' TreeMap that shall contain an
        element for each Image File to be used by this 'jFormTK' Application. This TreeMap
        is primarilly used to cycle thru the 'jFormTK' Applications Documentation images..

        The contents of the 'imageControl' TreeMap is created as a function of the
        'JDoc.jDocScriptControls' TreeMap that was established by the 'loadJDocScript' OR
        'adjustJDocScript' method of the 'jFormTK.Main' Class or their "Override" methods...
        Method of the 'jFormTK' Main Class...

        Kernel Usage:
        1)      'Main.init' to setup the 'imageControl' TreeMap for run-time usage and
                efficiency...
        


displayJDoc

public static java.lang.String displayJDoc(boolean debugGetImages)
Parameters:
debugGetImages - Get Images Debug flag [boolean]...

displayJDocScriptControls

public static java.lang.String displayJDocScriptControls(java.lang.String title,
                                                         boolean full)
        Produce a formatted display [String] of the 'JDoc.jDocScriptControls' instance.
        Construct a one OR two line display =f[full] parameter as follows:
                if (full)
                        Then display each 'key' all all of the values String array in a
                                two line format.
                else
                        Display one line for each entry showing the key, the Images Folder
                        String and the Tab Type control [tab,subTab,subTabTab].

                Add the given Title String [title] as the last line of the header...
        Kerel Usage:
        1)      This 'buildJDocScriptControls' Method for DEBUG...
        2)      This 'JDoc.overrideTab' Method for DEBUG...
        3)      This 'createDocumentationFiles' Method for DEBUG...
        4)      This 'getJPanel' Method if the given 'jDocScriptControls' KEY is NOT Found...
        4)      The Application Main program, i.e. the class that extendes 'jFormTK.Main'.
                Used in the 'adjustJDocScript' OR 'loadJDocScript' override method for DEBUG...
        

Parameters:
title - Sub-Title to specify the "FROM" DEBUG information...
full - Flag [boolean] to specify 1 OR 2 Line display per element...
Returns:
The formatted display String...

displayOrderControls

public static java.lang.String displayOrderControls(java.lang.String title,
                                                    boolean showNonNull)

displaySynopsisControls

public static java.lang.String displaySynopsisControls(java.lang.String title)

getJDocScriptControls

public static java.util.TreeMap getJDocScriptControls()
        Return the current 'jDocScriptControls' TreeMap...

        Kernel Usage:
        1)      '
        

Returns:
Hosted 'jDocScriptControls' TreeMap instance...

getImageFiles

public static java.lang.Object[][] getImageFiles(javax.swing.JProgressBar pb,
                                                 java.lang.String locationKEY)
        Return an Object array of the following Ordered Paits:
        1)      File Name [String]
        2)      Image File [ImageIcon] that match the given Location KEY...

        Kernel Usage:
        1)      'JDocumentation.doSlideSet' method after a Book|Chapter OR a
                Book|Chapter|Section selection has been made by the End User...
        

Parameters:
pb - JProgressBar instance from 'JDocumentation.GetSlideSet' Dialog...
locationKEY - Location KEY [String]...
Returns:
Array of Image Icons that matches the given Location KEY...

findImagesFolder

public static java.util.Vector findImagesFolder(java.lang.String tabFolder)

findSynopsis

public static java.lang.String[] findSynopsis(java.lang.String[] searchKeyWords)
Parameters:
searchKeyWords - String Array of Key Words to find...
Returns:
String Array = F[searchKeyWords]...

getSynopsisControls

public static java.util.TreeMap getSynopsisControls()
        Return the 'synopsisControls' Tree Map instance...

        Kernel Usage:
        1)      'JDocumentation.doFind' method to match a set of Key Words
                with each Slide Set Synopsis String. If a match is found, then a pseudo
                Book Mark is produced so that the End User can go to the associated 
                Slide Set presentation...
        

Returns:
The current 'synopsisControls' Tree Map...

overrideTab

public static java.util.Vector overrideTab(java.lang.String tabName)
        Utility method designed to add the "Override" controls to a Tab Name of
        the 'JDoc.jDocScriptControls' instance...

        Kernel Usage:
        1)      Convenience method called by the 'adjustJDoc' override method of the 'Main'
                'jFormTK' Sub-Class...
        

Parameters:
tabName - Tab Name to add the override Controls to...
Returns:
Vector of the Found 'tabName' with the found key [element 0] and the found and adjusted values String array [element 1]. NOTE: Currently used for DEBUG only...

XXXfindValues

public static int XXXfindValues(java.lang.String[][] values,
                                java.lang.String key)

getFileName

public static java.lang.String getFileName(java.lang.String key,
                                           int fileNumber,
                                           java.lang.String from)
        Return a String that contains the File Location and the file retrieval 'doCase'.
 
        The 'jFormTKDB.ItemsDelimiter is used to Delimit the two return String values...
 
        NOTE:
        If the return String is NOT found,
        Then a Soft Abort is performed with an annotation of the given parameters 
                and a snap shot of the current 'imageControl' TreeMap...
 
        Kernel Usage:
        1)      'JDocumentation.processSlides' Method to get the File Systems File 
                Locations String for an image file as a function of the given tab, subTab,
                sy=ubTabTab     and file Number parameters...
        

Parameters:
key - 'jDocScriptControls' Key [String]...
fileNumber - File Number [int]
from - DEBUG String annotation...
Returns:
Found File Name delimited String...

getImageIcon

public static javax.swing.ImageIcon getImageIcon(java.lang.String fileName)
        Return an 'ImageIcon' for the given 'fileName'...

        Kernel Usage:
        1)      'JHDD_IO.getIcon' Method to fetch an image from the 'JDoc.imageControls'
                TreeMap...
        

Parameters:
fileName - File Name String...
Returns:
An ImageIcon for the given File Name OR Null iff 'JDoc.imageControls' is enpty...

getImages

public static java.util.Vector getImages(java.lang.String searchPath)
        Construct a Vector of all the images in the 'JDoc.imageControls' TreeMap...

        Kernel Usage:
        1)      'JDoc.createDocumentationFiles' iff the 'debugTabs' AND the 'debugGetImagesAlso'
                Flags are set...
        

Parameters:
searchPath - TBD...
Returns:
Vector of found 'imgC' images...

getNumberOfSectionFiles

public static int getNumberOfSectionFiles(java.lang.String key,
                                          java.lang.String from)
        This method is designed to return the Number of Image Files associated with the
        given Documentation Book / Chapter / Section...
        
        This calculation is complicated somewhat by the existence of an "Ordered" Text
        File in the 'JDoc.orderedControls' Tree Map. The Text File may contain more or
        less image files then the number existing in the 'JDoc.imageControl' TreeMap.

        Kernekl Usage:
        1)      'JDoc.showJDoc' Method...
        1)      'BasejFormTK.displayImage' method to set the "of Max" annotation...
        2)      'BasejFormTK.JDocumentation.processLastSlide' method...
        3)      'BasejFormTK.JDocumentation.processNextSlide' method...
        4)      'BasejFormTK.JDocumentation.processPreviousSlide' method...
        

Parameters:
key - Key [String] for the section to be analyzed...
from - DEBUG String...
Returns:
Number of Images in Tab/SubTab [int]

getNumberOfChapters

public static int getNumberOfChapters(int bookIn)
        This method is designed to return the Number of unique Sub Tab's for the given
        Tab index [tab] of the current 'JDoc' instance...

        Kernel Usage:
        1)      'JRegistration.doWelcome' Method to construct the Welcome 'jFormTK' Message...
        2)      'BasejFormTK.BaseInfo.TabListener.stateChanged' to load the newly requested
                SubTab Panel...
        

Parameters:
bookIn - Book index [int]...
Returns:
Number of Sub-Tabs in the found Host Tab...

getNumberOfBooks

public static int getNumberOfBooks()
        This method is designed to return the Number of unique Tab's in the current
        'JDoc' instance...
 
        Kernel Usage:
        1)      'BasejFormTK.Constructor' to setup the Documentation 'tab' Panels...
        2)      'JEegistration.doWelcome' to construct a welcome message with references to
                the In-Line Documentation books and sub Tabs...
        X)      'JDocumentation.Constructor' to setup JPanel instances for each Tab / Sub-Tab
                JTabbedPane'...
        

Returns:
Number of Tab's [int] in 'JDoc' instance...

getBookItems

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

getChapterItems

public static java.lang.String[] getChapterItems(int bookIndex)
        Return a String Array of the 'Chapter' Controls for the given 'Book'...

        Kernel Usage:
        1)      'JDocumentation.doDisplayPanel' method when loading the 'Chapter' items for
                a selected 'Book'...
        

Parameters:
bookIndex - cbBook index for the Selected 'Book'
Returns:
String array with the 'jDocScriptControls'

getSectionItems

public static java.lang.String[] getSectionItems(int bookIndex,
                                                 int chapterIndex)
        Return a String Array of the 'Section' Controls for the given 'Book' and Chapter...

        Kernel Usage:
        1)      'JDocumentation.doDisplayPanel' method when loading the 'Chapter' items for
                a selected 'Book'...
        

Parameters:
bookIndex - cbBook index for the Selected 'Book'
Returns:
String array with the 'jDocScriptControls'

XXXgetSectionItems

public static java.lang.String[] XXXgetSectionItems(int bookIndex,
                                                    int chapterIndex,
                                                    int sectionIndex)

getLabel

public static java.lang.String getLabel(int book,
                                        int chapter,
                                        int section)
        This method is designed to return the 'Label' Field of the indicated TAB Field...
        

Parameters:
book - Book index [int].
chapter - Chapter index [int].
section - Section index [int].
Returns:
Tab label String = f[book.chapter.section]...

getTabLabel

public static java.lang.String getTabLabel(java.lang.String locationKey)

getTabParameters

public static java.util.Vector getTabParameters(java.lang.String tabType)
        Produce a Vector that contains the specified elements of the 'jDocScriptControls'
        instance. The Tab Type to be selected =f[tabType parameter]...

        Kernel Usage:
        1)      'this.createDocumentationFiles' method...
        

Parameters:
tabType - Tab Type to be selected from the 'tabConttrolsTree' instance. The 'tabType' is matched to the Tab Type element of the 'jDocScriptControls' 'values' Vector...
Returns:
Vector of String Array as shown above...

getValues

public static java.lang.String[] getValues(java.lang.String key,
                                           java.lang.String from)
        Return the Values String Array = f[tabControls Key] indexes...
        The Object [] array [objects] is converted to a String array [values] and
        the objects[5] JPanel instance is ignored...
                NOTE:   Return Values String array elements...
                values[0]       -       'Tab' OR 'SubTab' OR Section 'jDocScriptControls' KEY...
                values[1]       -       Image Folder Location..
                values[2]       -       Tab Name...
                values[3]       -       Tab Label...
                values[4]       -       Tab Synopsis/keyWordData...
        
        Kernel Usage:
        1)      'JDocumentation.Constructor' to setup the Documention Tab Panels...
        

Parameters:
key - 'jDocScriptControls' Key String...
from - DEBUG annotation String...
Returns:
Found 'values' String Array OR 'null' if 'searchKey' is NOT Found...

isJDocScriptControls

public static boolean isJDocScriptControls(java.lang.String key)
        Return a boolean of true iff the given key is in the 'jDocScriptControls'...

        Kernel Usage:
        1)      'JDocumentation.makeLocationKey' method to verify the constructed
                'jDocScriptControls' element existance...
        

Parameters:
key - 'jDocScriptControls' TreeMap Key...
Returns:
Flag [boolean] =f[jDocScriptControls.containsKey(key)]...

putImageControls

public void putImageControls(java.lang.String key,
                             int imageType,
                             java.lang.String extension,
                             javax.swing.ImageIcon img)
        Place an entry into the 'JDoc.imageControls' TreeMap...

        Kernel Usage:
        1)      This 'addImageControl' Method after processing the 'jFormTK' images Tier Rules...
        2)      'JHDD_IO.getIcon' Method to save images that were required by the 'jFormTK'
                Kernel prior to the establishment of the 'imageIcons' TreeMap...
        

Parameters:
key - File Name KEY String...
imageType - 'int' for Tier Type Control...
extension - Image File extension ["gif" OR "jpg"] String...
img - Control Image Icon File to be set in the 'this.icon' control...

showImageControls

public static void showImageControls(java.lang.String title)
        Present a dialog that list all the 'jFormTK' Image File Names and a column that
        illustrates the file source of each Image File, i.e. the HDD Folder or JAR file
        where the Image File was found...
 
        Kernel Usage:
        1)      Selected from the "Debug" Menu during Run-Time...
        2)      'JDoc.createDocumentationFiles' method for DEBUG purposes...
        

Parameters:
title - Title for the display 1st line...

showOrderControls

public static void showOrderControls(java.lang.String annotation)
        Display the current content of the 'JDoc.orderControls' Tree Map...

        Kernel Usage:
        1)      As required for DEBUG of the 'jFormTK' Kernel...
        

Parameters:
annotation - String to be used as the 2nd Line in the Display Header...

showJDocScriptControls

public static void showJDocScriptControls(java.lang.String annotation)

showOverrideControls

public static void showOverrideControls(char mode)
        Show the 'JDoc.tierControl' TreeMap...
 
        Kernel Usage:
        1)      'this.createDocumentationFiles' Method for DEBUG purposes...
        2)      Selected from the "Debug" Menu during Run-Time... 
        


showSynopsisControls

public static void showSynopsisControls(char mode,
                                        java.lang.String from)
        Show the 'JDoc.synopsisControl' TreeMap...
 
        Kernel Usage:
        1)      'this.createDocumentationFiles' Method for DEBUG purposes...
        2)      Selected from the "Debug" Menu during Run-Time...