com.jFormTK
Class JDocControls

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

 class JDocControls
extends java.lang.Object
implements JConstants

        This class is designed to contain the Tree Maps designed to control the Documentation
        'Book/Chapter/Section' processing...

        NOTE 1: "Tab Sets":
        The 'jDocTK' Package is designed to display collections of image files organized by
        the following TABs: "Book", "Chapter" and "Section". The "Section" TAB is optional.
        The Tab Sets are instanced as a function of the 'jDocTK' Script file.
        Tab Sets exist for each 'Book|Chapter' OR 'Book|Chapter|Section' described in the
        'jDocTK' Script file.

        NOTE 2: "Slide Set":
        Each 'Tab Set' is assigned a collection of image files to be displayed when the
        'jDocTK' End User selects a unique 'Tab Set'. This collection of image files is
        referred to as the 'Slide Set". 

        NOTE 3: "Location KEY"
        Each 'Tab Set' is identified by the 'jDocTK' 'Location KEY' type.
        There is a unique 'Location KEY' for each 'Tab Set' constructed as follows:
                Location KEY in the "__A__B__C" format
                        where   _       is the space character
                                        'A'     is the Book Index +1
                                        'B'     is the Chapter Index
                                        'C'     is the Section Index if a 3rd tier of images is used.
                                        If No 3rd Tier [Section] then the locationKEY = "  A  B"

        There are two TreeMap objects as follows:

        'controls'      'KEY' is the 'Location KEY'.
                                'VALUE' object contains a 'control' Object used to display the
                                'Book/Chapter/Section' list items in a productive manner.
                                The 'control' Object is designed as follows:
                                Format  |       Usage...
                                ________|_____________________________________________________________
                                'Null'  |       Associated 'Tab Set' has never been viewed...
                                String  |       'Location Key' to the last Book OR Chapter...
                                Integer |       Contains an 'int' for the last image # displayed when the
                                                |       associted Documentation item was unloaded...
                                ________|_____________________________________________________________

        'markNames'     There are two kinds of 'marks', the 'Key Word' mark and the 'Book Mark' mark.
                                The 'marks' each have a unique 'name'.
                                The 'keyWordName' name is derived from the 'JDoc' Script 'Key Word Data'
                                parameters.
                                The 'bookMark' is assigned a name that is constructed, by default, as the
                                'Location KEY' appened with the current Slide Number. This 'bookMark' name
                                may be converted to a mneumonic name at the time the 'bookmark' is requested
                                by the 'jDocTK' End User.

                                Each 'mark' is used to branch to a specific Slide of a specific
                                Book|Chapter or Book|Chapter|Section 'Tab Set'. Each 'Tab Set' is
                                uniquely identified by it's 'Location KEY'.

                                The TreeMap 'KEY' is the unique 'mark' name String...
                                The TreeMap 'VALUE' is the following String Array:
                                        array[0]        -       "K" or "B" to identify the 'mark' Origin [Key Word
                                                                        OR Book Mark].
                                        array[1]        =       The Slide Set 'Location Key'...
                                        array[2]        =       The Slide Number [as a String type]...

        'keyWord'
                                The key_Word String as derived from the 'JDoc' Script...
                                The TreeMap 'key' is the 'Slide Set' Location KEY...
                                The TreeMap 'value' is a set of Key Words to reference the associated
                                Slide Set, i.e. key words from the Slide Set scenario of the 'JDoc'
                                Script. The key words use the COMMA as their delimiter...

        'bookMark'      The run_time Book Mark parameters. An entry is made dynamically iff the
                                'JDocTK' End User request a Book Mark.
                                The TreeMap 'key' is the Slide Set Location KEY...
                                The TreeMap 'value' is a TreeMap constructed as follows:
                                -       'key'   Slide number String...
                                =       'value' Book Mark Mnemonic Name String...

        Kernel Usage:
        1)      Hosted by the Application Data Base [AppDB] and instanced by the 'AppDB.initialize'
                method...
        2)      Initialized by the 'JDoc.buildJDocScriptControls' method...
        3)      Saved to the 'AddressBook' HDD file by the TBD
        4)      Loaded from the 'JHDD_IO.readJAddressBook' method during the 'jFormTK'
                Application load phase...
        

Version:
1.00, Dec, 2007
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
static java.util.TreeMap controls
           
static java.util.TreeMap markNames
           
 
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
JDocControls()
           'JDocControls' Constructor...
 
Method Summary
static void addBookMark(java.lang.String locationKEY, int iSlide, java.lang.String mnemonicName)
           Add the given Slide index [iSlide] and 'mnemonic Book Mark Name [mnemonicName] to the 'JDocControls' BookMarks instance.
static void addBookMark(java.lang.String locationKEY, java.lang.String slide, java.lang.String mnemonicName)
           Add the given Slide index String [Slide] and 'mnemonic Book Mark Name [mnemonicName] to the 'JDocControls.markNames' instance.
static java.lang.String addKeyWord(java.lang.String locationKEY, int iSlide, java.lang.String keyWordName)
           Add the given Slide index [iSlide] and 'Key Word' Name [keyWordName] to the 'JDocControls.keyWord' TreeMap instance.
static void addToHistory(java.lang.String add)
           Add the given string to the 'JDocControls' History value.
static java.lang.String displayBookMarks(java.lang.String from)
           Display ONLY the 'marks' with the BookMark Origins in the 'markNames' TreeMap Collection...
static java.lang.String displayHistory(java.lang.String from)
           
static java.lang.String displayJDocControls(boolean full)
           Prepare a display String for the current 'JDocControls' instance...
static java.lang.String displayKeyWords(java.lang.String from)
           Display ONLY the 'marks' with the 'Key Word' Data Origins in the 'markNames' TreeMap Collection...
static java.lang.String displayMarkNames()
           
static java.lang.String[] getBookChapterNames()
           Compose and return a String Array of the 'Book|Chapter' Names in the 'JDoc' Script...
static java.lang.String[][] getBookMarksArray()
           Return a two dimensional String Array of the Book Marks in the 'markNames' instance.
static int[] getBookMarkSlides(java.lang.String locationKEY)
           Return an 'int' Array with an entry for each slide of the specified Slide Set [locationKEY] that has a Book Mark assignment...
static JTableShell getBookMarksTable(boolean debug)
           Construct a 'JTableShell' instance for the 'Book Mark' Collection with only the 'Key Word' entries...
static java.lang.String[] getBookNames()
           Compose and return a String Array of the 'Book' Names in the 'JDoc' Script...
static JTableShell getFoundNamesTable(java.util.Vector foundNames, java.lang.String[] keyWords)
          Construct a 'JTableShell' instance for the given 'Found Names' Collection =F[Vector 'foundNames']...
static java.lang.StringBuffer getHistory()
           Get the History String from the 'controls' TreeMap...
static java.lang.String[][] getKeyWordsArray()
           Return a two dimensional String Array of the Key Words in the 'markNames' instance.
static JTableShell getKeyWordsTable(boolean debug)
           Construct a 'JTableShell' instance for the 'markNames' Collection with only the 'Key Word' entries...
static java.lang.String getLastLocationKEY()
           Return the Last Location KEY 'value'...
static java.util.TreeMap getMarkNames()
           
static java.lang.String[][] getMarkNamesArray()
           Return a two dimensional String Array of the Mark Names.
static JTableShell getMarkNamesTable(boolean debug)
           Construct a 'JTableShell' instance for the 'markNames' Collection, i.e.
static java.lang.String getNextSlideSet(java.lang.String currentLocationKEY)
           Given the current Location KEY [currentLocationKEY] find the next Location KEY in the 'controls' Collection...
static java.lang.String getPreviousSlideSet(java.lang.String currentLocationKEY)
           Given the current Location KEY [currentLocationKEY] find the previous Location KEY in the 'controls' Collection...
static java.lang.Object getValue(java.lang.String locationKEYIn, java.lang.String from)
           Return the value [Object] associaed with the given Location KEY...
static boolean hasSlideSets(java.lang.String locationKEY)
           Return a boolean flag that indicates if the given Location KEY has a set of Documentation slides assigned to it.
static boolean isBookMarks()
           Return a flag to indicate if there are any Book Marks in the current 'markNames' collection...
static boolean isLoaded()
           
static boolean isLocationKey(java.lang.String locationKEY)
           
static void load(java.lang.String savedJDocControls)
           Load the AppDB.JDocControls instance from the 'JDocControls' Saved String...
static void removeBookMark(java.lang.String locationKEY, int iSlide)
           Remove the specified Book Mark = f[locationKEY & iSlide] fron the 'JDocControls' markNames TreeMap instance.
static void removeBookMark(java.lang.String locationKEY, java.lang.String slide)
           Remove the specified Book Mark = f[locationKEY & iSlide] fron the 'JDocControls' markNames TreeMap instance.
static void setControl(java.lang.String key)
           Place an entry into the 'JDoc' Controls Tree Map with a 'null' cintrol value...
static void setControl(java.lang.String key, int imageIndex)
           Place an entry into the 'JDoc' Controls Tree Map.
static void setControl(java.lang.String key, java.lang.String value)
           Place an entry into the 'JDoc' Controls Tree Map.
static void setControl(java.lang.String key, java.lang.StringBuffer value)
           Place an entry into the 'JDoc' Controls Tree Map.
static void setHistory(java.lang.String history)
           Set the 'History' concatenated String...
static void setLastLocationKEY(java.lang.String key)
           Set the Last Location KEY in the 'JDocControls'...
static void showBookMarks(java.lang.String from)
           
static void showHistory(java.lang.String from)
           
static void showJDocControls(boolean full, java.lang.String from)
           Display the 'JDocControls' in a Message Dialog...
static void showKeyWord(java.lang.String from)
           
static void showMarkNames(java.lang.String from)
           
 java.lang.String toString()
           Create a "Saved" String for the current 'JDocControls' TreeMap [controls]...
static void XXXshowBookMarks(javax.swing.JTable tBookMarks)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

controls

public static java.util.TreeMap controls

markNames

public static java.util.TreeMap markNames
Constructor Detail

JDocControls

JDocControls()
        'JDocControls' Constructor...

        Kernel Usage:
        1)      'AppDB.initialize' method...
        

Method Detail

addBookMark

public static void addBookMark(java.lang.String locationKEY,
                               int iSlide,
                               java.lang.String mnemonicName)
        Add the given Slide index [iSlide] and 'mnemonic Book Mark Name [mnemonicName]
        to the 'JDocControls' BookMarks instance.

        Kernel Usage:
        1)      'JDocumentation.toggleMark' method whrn the 'bMarkOFF' button is pressed...
        

Parameters:
locationKEY - Location KEY [String] to add the Book Mark parameters...
iSlide - Slide index [int] to Book Mark...
mnemonicName - Mnemonic Name [String] assigned to this Book Mark...

addBookMark

public static void addBookMark(java.lang.String locationKEY,
                               java.lang.String slide,
                               java.lang.String mnemonicName)
        Add the given Slide index String [Slide] and 'mnemonic Book Mark Name [mnemonicName]
        to the 'JDocControls.markNames' instance.

        If the 'mnemonicName' already exist in the 'markNames' Tree Map,
        Them execute a Soft Abort...

        Kernel Usage:
        1)      'this.setBookMarks' method iff the unpacked String Array has the required
                three entries, i.e. locationKEY, Slide #, Book Mark name...
        

Parameters:
locationKEY - Location KEY [String] to add the Book Mark parameters...
slide - Slide index [String] to Book Mark...
mnemonicName - Mnemonic Name [String] assigned to this Book Mark...

addKeyWord

public static java.lang.String addKeyWord(java.lang.String locationKEY,
                                          int iSlide,
                                          java.lang.String keyWordName)
        Add the given Slide index [iSlide] and 'Key Word' Name [keyWordName]
        to the 'JDocControls.keyWord' TreeMap instance.

        Kernel Usage:
        1)      'JDoc.processKeyWord' method when a 'keyWord' String is found in the
                'jDocTK' JDoc Script File...
        

Parameters:
locationKEY - Location KEY [String] to add the Key Word parameters...
iSlide - Slide index [int] for the Meat Data Name...
keyWordName - Key Word Name [String] assigned to this 'mark'...
Returns:
String with Soft Abort Parameters iff the 'keyWordName' is a duplicate...

addToHistory

public static void addToHistory(java.lang.String add)
        Add the given string to the 'JDocControls' History value.
        Insert a 'JFormTKDB' Items delimiter after the 'add' String iff
        'add' is not null...

        Kernel Usage:
        1)      'JDocumentation.doSlideSet' method to add the History parameters for the
                'Book|Chapter' OR 'Book|Chapter|Section' Slide Set to be displayed...
        2)      'JDocumentation.processExit' method to add an entry when the 'JDocumentation'
                processing is terminated...
        

Parameters:
add - History concatenated String using the JFormTKDB items delimiter and an abreviated "Time Stamp" String as follows: 1) Time Stamp

displayMarkNames

public static java.lang.String displayMarkNames()

displayBookMarks

public static java.lang.String displayBookMarks(java.lang.String from)
        Display ONLY the 'marks' with the BookMark Origins in the 'markNames' TreeMap
        Collection...

        Kernel Usage:
        1)      TBD
        

Parameters:
from - DEBUG 'from' annotation...
Returns:
String to display ONLY the "B" origin entries...

displayHistory

public static java.lang.String displayHistory(java.lang.String from)

displayJDocControls

public static java.lang.String displayJDocControls(boolean full)
        Prepare a display String for the current 'JDocControls' instance...

        Kernel Usage:
        1)      'JDocumentation.constructor.itemStateChanged' Method for a Soft TRAP when
                a 'JDocContols' Chapter does not contain an expected 'locationKEY' [String]
                OR a last Slide Index [Integer] value...
        2)      'JDocumentation.Constructor.Anonymous Class for a "Chapter" when the
                Chapter Location KEY is invalid...
        3)      'this.getValue' method to produce a Soft Abort when an illegal Location
                KEY is found in the 'JDocControls' TreeMap instance...
        4)      'this.load' method to produce a Developers warning because the
                'JDocControls' instance was not initialized as designed...
        5)      'this.load' method when the ordered pair of a 'History' entry
                contains a 'value' String with the wrong [or ,issing] prexix code...
        6)      'this.showJDocControls' method...
        

Parameters:
full - Flag [boolean] to control the display result...
Returns:
'JDocControls' formatted String...

displayKeyWords

public static java.lang.String displayKeyWords(java.lang.String from)
        Display ONLY the 'marks' with the 'Key Word' Data Origins in the 'markNames'
        TreeMap Collection...

        Kernel Usage:
        1)      TBD
        

Parameters:
from - DEBUG 'from' annotation...
Returns:
String to display ONLY the "K" origin entries...

getBookNames

public static java.lang.String[] getBookNames()
        Compose and return a String Array of the 'Book' Names in the 'JDoc' Script...

        Kernel Usage:
        1)      'JDocumentation.doHistory.HistoryFilter.doDisplay' method when the
                'Book' Filter is applied...
        

Returns:
String array of the 'Book' Names...

getBookChapterNames

public static java.lang.String[] getBookChapterNames()
        Compose and return a String Array of the 'Book|Chapter' Names in the 'JDoc' Script...

        Kernel Usage:
        1)      'JDocumentation.doHistory.HistoryFilter.doDisplay' method when the
                'Book|Chapter' Filter is applied...
        

Returns:
String array of the 'Book' Names...

getBookMarksArray

public static java.lang.String[][] getBookMarksArray()
        Return a two dimensional String Array of the Book Marks in the 'markNames' instance.
        The constructed String array dimensions are [n][3] where 'n' is the number of Book
        Marks and the Return String Array [returnString] format is as follows:
                [i][0]  -       Book Mark Name...
                [i][1]  -       Slide Set "Location Key"...
                [i][2]  -       Slide Number [String]...

        Kernel Usage:
        1)      This 'getBookMarksTable' Method to get the data to be placed into the
                Book Marks JTable...
        2)      'JDocumentation.doGoTo' Method to get an array of the existing Book Marks...
        

Returns:
String Array [3][n] {see above}...

getKeyWordsArray

public static java.lang.String[][] getKeyWordsArray()
        Return a two dimensional String Array of the Key Words in the 'markNames' instance.
        The constructed String array dimensions are [n][3] where 'n' is the number of Key
        Words and the Return String Array [retrunString] format is as follows:
                [i][0]  -       Key Word Name...
                [i][1]  -       Slide Set "Location Key"...
                [i][2]  -       Slide Number [String]...

        Kernel Usage:
        1)      This 'getBookMarksTable' Method to get the data to be placed into the
                Key Words JTable...
        2)      'JDocumentation.doFind' Method to get an array of the existing Key Words...
        

Returns:
String Array [3][n] {see above}...

getBookMarkSlides

public static int[] getBookMarkSlides(java.lang.String locationKEY)
        Return an 'int' Array with an entry for each slide of the specified Slide Set
        [locationKEY] that has a Book Mark assignment...

        Kernel Usage:
        1)      'JDocumentation.doDisplayPanel' method when a new Slide Set is displayed...
        

Parameters:
locationKEY - Location Key [String[ for the current Slide set...
Returns:
The 'int' Array...

getBookMarksTable

public static JTableShell getBookMarksTable(boolean debug)
        Construct a 'JTableShell' instance for the 'Book Mark' Collection with
        only the 'Key Word' entries...

        Kernel Usage:
        1)      'JDocumentation.JEditBookMarks.Constructor'...
        2)      'JDocumentation.SelectBookMark.Constructor'...
        

Parameters:
debug - DEBUG boolean Flag...
Returns:
'JTableShell' instance with Book Mark Table and JScrollPane...

getFoundNamesTable

public static JTableShell getFoundNamesTable(java.util.Vector foundNames,
                                             java.lang.String[] keyWords)
Construct a 'JTableShell' instance for the given 'Found Names' Collection =F[Vector 'foundNames']... Kernel Usage: 1) 'JDocumentation.SelectSearchItem.doFind' method to remove the Search Key Words / Book Marks [Optional] Table [searchShell.Table] and show the "Found Names' Table [foundShell.Table]...

Returns:
'JTableShell' instance with Found Names Vector Table and JScrollPane...

getHistory

public static java.lang.StringBuffer getHistory()
        Get the History String from the 'controls' TreeMap...

        Kernel Usage:
        1)      'this.addToHistory' Method to get the StringBuffer to be concatenated with
                a new History encoded record...
        2)      'this.displayHistory' Method to get the 'History' StringBuffer to be decoded
                and displayed...
        3)      'JDocumentation.doHistory' method when the End User selects the 'bHistory'
                JButton OR enters the ALT / H key combinations...
        

Returns:
Current encoded History String from the 'HISTORY' element of the 'JDocControls.controls' TreeMap...

getKeyWordsTable

public static JTableShell getKeyWordsTable(boolean debug)
        Construct a 'JTableShell' instance for the 'markNames' Collection with
        only the 'Key Word' entries...

        Kernel Usage:
        1)      'JDocumentation.SelectSearchItem.Constructor' iff the "SearchMarkNamesFlag"
                JFormTKDB flag is false...
        

Parameters:
debug - DEBUG boolean Flag...
Returns:
'JTableShell' instance with Key Words Table and JScrollPane...

getLastLocationKEY

public static java.lang.String getLastLocationKEY()
        Return the Last Location KEY 'value'...

        Kernel Usage:
        1)      'JDocumentation.Constructor' when initializing the 'JDocumentation' Dialog...
        

Returns:
Value String from 'JDocControls'...

getMarkNamesArray

public static java.lang.String[][] getMarkNamesArray()
        Return a two dimensional String Array of the Mark Names.
        The constructed String array dimensions are [n][3] where 'n' is the number of Mark
        Names and the Return String Array [retrunString] format is as follows:
                [i][0]  -       Key Word Name OR Book Mark Name...
                [i][1]  -       Slide Set "Location Key"...
                [i][2]  -       Slide Number [String]...

        Kernel Usage:
        1)      This 'getMarkNamesTable' Method to get the data to be placed into the
                Key Words JTable...
        2)      'JDocumentation.doFind' Method to get an array of the existing Key Words...
        

Returns:
String Array [3][n] {see above}...

getMarkNames

public static java.util.TreeMap getMarkNames()

getMarkNamesTable

public static JTableShell getMarkNamesTable(boolean debug)
        Construct a 'JTableShell' instance for the 'markNames' Collection, i.e. with
        both the Key Words and the Dynamic Book Mark Collections...

        Kernel Usage:
        1)      'JDocumentation.SelectSearchItem.Constructor' iff 'JFormTKDB.SearchMarkNamesFlag'
                is true.        
        

Parameters:
debug - DEBUG boolean Flag...
Returns:
'JTableShell' instance with Mark Names Table and JScrollPane...

getNextSlideSet

public static java.lang.String getNextSlideSet(java.lang.String currentLocationKEY)
        Given the current Location KEY [currentLocationKEY] find the next Location
        KEY in the 'controls' Collection...

        If the given current Location KEY is the last entry in the 'controls' collection,
        Then return the first Location KEY of the 'controls' collection.

        NOTE:
        By definition the Location KEY for the first entry in "  1", i.e.
        the First BOOK of the collection. This Location KEY is hard wired because the
        'controls' collection has two key entries that are NOT actually a Location KEY.
        The two keys are as follows:
                a)      KEY = "  0" is the header key. The associated 'value' is the Location KEY
                        for the last Slide Set that was displayed.
                b)      KEY = HISTORY [currently "999"] is the history entry. The associated
                        'value' contains a String with the End User usage "History" parameters...

        Kernel Usage:
        1)      'JDocumentation.showSlides' Method when the last slide of the current Slide Set
                is in Focus, the 'Roll' Toggle is ON and the Next Slide is requested by the
                End User...
        

Parameters:
currentLocationKEY - The current Location KEY String...
Returns:
The next Location KEY String as defined above...

getPreviousSlideSet

public static java.lang.String getPreviousSlideSet(java.lang.String currentLocationKEY)
        Given the current Location KEY [currentLocationKEY] find the previous Location
        KEY in the 'controls' Collection...

        If the given current Location KEY [currentLocationKEY] is the first entry in the
        current Book,
        Then
                1)      Present a Warning Message to the End User
                2)      Return the first Location KEY of the current Book.

        NOTE:

        Kernel Usage:
        1)      'JDocumentation.showSlides' Method when the first slide of the current Slide Set
                is in Focus, the "Roll' Toggle is active and a Previous Slide is requested by
                the End User...
        

Parameters:
currentLocationKEY - The current Location KEY String...
Returns:
The next Location KEY String as defined above...

getValue

public static java.lang.Object getValue(java.lang.String locationKEYIn,
                                        java.lang.String from)
        Return the value [Object] associaed with the given Location KEY...

        Kernel Usage:
        1)      'JDocumentation.Constructor.anoymous' Inner Class to service the
                'Books' Combo Box...
        2)      'JDocumentation.Constructor.anoymous' Inner Class to service the
                'Chapter' Combo Box...
        3)      'JDocumentation.Constructor.anoymous' Inner Class to service the
                'Section' Combo Box...
        4)      'JDocumentation.Constructor' to service the "Last Location KEY"
                during the 'jFormTK' initialization phase...
        

Parameters:
locationKEYIn - Location Key [String] to be used a 'JDocControls' Tree Map key...
Returns:
The value [Object] associated with the 'locationKEY' key...

hasSlideSets

public static boolean hasSlideSets(java.lang.String locationKEY)
        Return a boolean flag that indicates if the given Location KEY has a set of
        Documentation slides assigned to it. This method is used by the JDocControl
        methods that search for the Previous OR Next 'Slide Set' to ensure that
        the Location KEY that does not contain a Slide Set is NOT returned.

        NOTE:
        The 'controls' TreeMap Key is a "Location KEY" for each "Book", "Book|Chapter"
        and "Book|CHapter|Section" of the JDoc Script. The associated 'value' is a
        Object field the is used to control the state of each "Location KEY" element.

        All "Book" Location KEY entries must reference a "Book|Chapter" entry.

        Each "Book|Chapter" entry may or may not reference a "Book|Chapter|Section" entry,
        i.e "Book|Chapter" entries conditionally contain one of more "Book|Chapter|Section"
        entries.

        If a "Book|Chapter" entry has no associted "Book|Chapter|Section" entries,
        Then a "Book|Chapter" 'Slide Set' is defined by the JDoc Script.

        If a "Book|Chapter|Section" exist,
        Then a 'Slide Set' is required and it's host "Book|Chapter" entry SHALL NOT
                contain a 'Slide Set'.

        Kernel Usage:
        1)      'this.getPreviousSlideSet' method to ensure the return Location KEY
                has an associated "Slide Set"...        
        
        

Parameters:
locationKEY - The Location KEY [String] to evaluate...
Returns:
A boolean Flag indication if a Slide Set exist...

isBookMarks

public static boolean isBookMarks()
        Return a flag to indicate if there are any Book Marks in the current
        'markNames' collection...

        Kernel Usage:
        1)      'JDocumentation.showSlides' method to control the state of the "Go To Book Mark"
                button [bGoTo]...
        

Returns:
Flag [boolean] to indicate Book Mark Exist...

isLoaded

public static boolean isLoaded()

isLocationKey

public static boolean isLocationKey(java.lang.String locationKEY)

load

public static void load(java.lang.String savedJDocControls)
        Load the AppDB.JDocControls instance from the 'JDocControls' Saved String...

        Kernel Usage:
        1)      'JHDD_IO.readJAddressBook' method during the 'jFormTK' Application load
                stage...
        

Parameters:
savedJDocControls - A 'JFormTKDB.fieldsDelimiter' delimited String that is constructed by the 'JDocControls.toStrint' method...

removeBookMark

public static void removeBookMark(java.lang.String locationKEY,
                                  int iSlide)
        Remove the specified Book Mark = f[locationKEY & iSlide] fron the 'JDocControls'
        markNames TreeMap instance.

        Kernel Usage:
        1)      'JDocumentation.toggleMark' method whrn the 'bMarkOFF' button is pressed...
        

Parameters:
locationKEY - Location KEY [String] to remove the Book Mark parameters...
iSlide - Slide index [int] to Book Mark...

removeBookMark

public static void removeBookMark(java.lang.String locationKEY,
                                  java.lang.String slide)
        Remove the specified Book Mark = f[locationKEY & iSlide] fron the 'JDocControls'
        markNames TreeMap instance.

        If the specified Book Mark does not exist,
        Then produce a SOGTWARE TRAP Soft Abort...

        Kernel Usage:
        1)      'this.setBookMarks' method iff the unpacked String Array has the required
                three entries, i.e. locationKEY, Slide #, Book Mark name...
        

Parameters:
locationKEY - Location KEY [String] to the Book Mark parameters...
slide - Slide index [String] to Book Mark...

setHistory

public static void setHistory(java.lang.String history)
        Set the 'History' concatenated String...

        Kernel Usage:
        1)      'JDoc.buildJDocScriptControls' to initialize the 'controls.HISTORY' element
                with a null String...
        

Parameters:
history - String to set the History control...

setControl

public static void setControl(java.lang.String key,
                              java.lang.String value)
        Place an entry into the 'JDoc' Controls Tree Map.
        At the Tree Map entry for the given KEY [key] set the value to the given
        "Last Location KEY" String...

        Kernel Usage:
        1)      'this.load' method to set each ordered pair from the saved String iff
                the Variabl String has an 'S' prefix...
        

Parameters:
key - Location KEY for a specific 'Book/Chapter/Section' [String].
value - Value [String] of Ordered Pair for 'key'.

setControl

public static void setControl(java.lang.String key,
                              java.lang.StringBuffer value)
        Place an entry into the 'JDoc' Controls Tree Map.
        At the Tree Map entry for the given KEY [key] set the value to the given
        "Last Location KEY" String...

        Kernel Usage:
        1)      'this.load' method to re-load the HISTORY ordered pair...
        2)      'this.addToHistory' method to append a 'History' record...
        3)      'this.setHistory' method to initialize OR Clear the 'History' parameter...
        

Parameters:
key - Location KEY for a specific 'Book/Chapter/Section' [String].
value - StringBuffer Value of Ordered Pair for 'key'.

setControl

public static void setControl(java.lang.String key,
                              int imageIndex)
        Place an entry into the 'JDoc' Controls Tree Map.
        At the Tree Map entry for the given KEY [key] set the value to an Integer component
        the host the given Image Index [imageIndex]...

        Kernel Usage:
        1)      'JDocumentation.showSlides' method to re-set the 'JDocControlValues'
                last Slide index when a Slide Set has been unloaded via the 'Roll'
                processor.
        

Parameters:
key - Location KEY for a specific 'Book/Chapter/Section' [String].
imageIndex - Image Index the is displayed presently [int], i.e. when the 'Book/Chapter/Section' Image Panel was unloaded...

setControl

public static void setControl(java.lang.String key)
        Place an entry into the 'JDoc' Controls Tree Map with a 'null' cintrol value...

        Kernel Usage:
        1)      'JDoc.buildJDocScriptControls' to initialize the keys to a 'Null'...
        2)      'this.load' method to set a "Location Key" value to 'Null' if the 'value'
                Object was 'Null' when the Save 'JDocControls' process was last performed...
        

Parameters:
key - Location KEY for a specific 'Book/Chapter/Section' [String].

setLastLocationKEY

public static void setLastLocationKEY(java.lang.String key)
        Set the Last Location KEY in the 'JDocControls'...

        Kernel Usage:
        1)      'JDocumentation.setControls' Method...
        2)      'JDocumentation.JDocumentationWindow.windowClosing' Method...
        

Parameters:
key - Last Location KEY String...

showMarkNames

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

showBookMarks

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

XXXshowBookMarks

public static void XXXshowBookMarks(javax.swing.JTable tBookMarks)

showHistory

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

showJDocControls

public static void showJDocControls(boolean full,
                                    java.lang.String from)
        Display the 'JDocControls' in a Message Dialog...

        Kernel Usage:
        1)      DEBUG tool - used as required by 'jFormTK' Kernel / Application Developers...
        

Parameters:
full - Flag [boolean] to control display content.
from - String to annotate who envoked this DEBUG method.

showKeyWord

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

toString

public java.lang.String toString()
        Create a "Saved" String for the current 'JDocControls' TreeMap [controls]...
        The constructed string has the following format:
                1)      'key' String...
                2)      Items Delimiter...
                3)      'value' String...
                        NOTE 1: If the 'value' was a 'null', then the null String is returned...
                        NOTE 2: If the 'value' was an Integer, then the associated 'int' is returned...
                4)      Items Delimiter...
                5)      Fields Delimiter...

        This String is used to reload the 'JDocControls' instance during the 'jFormTK'
        Application 'load' Phase...

        Kernel Usage:
        1)      'JHDD_IO.writeJAddressBook' method...
        

Overrides:
toString in class java.lang.Object