com.jFormTK
Class JPromptPhrase

java.lang.Object
  com.jFormTK.JPromptPhrase

All Implemented Interfaces:

JConstants

public class JPromptPhrase
extends java.lang.Object
implements JConstants

        This 'jFormTK' Kernel class is designed to contain the "Prompt Phrase" Controls for
        the 'jFormTK' Application...

        There may be multiple phrase separated by the JFormTK.itemsDelimiter.
        Each individual phrase has the following Fields separated by the 'jFormTKDB.groupSaveDelimiter':
        1)      Phrase String, i.e. the Phrase to search for in each Prompt...
        2)      {Optional}Encoded 'JLAF' for the Associated 'Phrase String'...
        NOTE:
        If no 'encodedjLAF' is given the 'jFormTK' Kernel shall use the
        'JFormTKDB.promptPhraseLAF' instance to control the matching Phrased Look And Feel...  

        This class is instanced by the 'jFormTK' 'Main.java' Class iff the 'AppDB.AppCommonDB'
        'promptPhraseList' Element is NOT 'Null'...
        [The 'jFormTK' Package default is 'null'].
 
        The 'jFormTK' Kernel developer can establish a 'prompPhraseList' AppCommonDB' element
        by overriding the 'loadAppCommonDB' Method of the 'jFormTK.Main' Super-Class in their
        Application Main Program [Sub-Class of 'jFormTK.Main']....
        [See 'Getting Started: AppCommonDB' Doc]
 
        Kernel Usage:
        1)      The 'Util.buildStylePrompt' method uses this class when construction the Prompt
                Line for future presentation by the 'JFormFrame.setPrompt' 'Run-Time' Method...

        2) The Prompt Phrases are designed to be "Dynamic", therefore any control may be
                modified during Run-Time via this Class. This is accomplished because
                'jFormTK.AppCommonDB' class is "Dynamic" in that it is initialized once from the
                and written to the JAddressBook' file...
                Once it is established, it is instanced from the JAddressBook each time the
                'jFormTK' Kernel Application is reloaded. 
        

Version:

1.00, 3 Jul 2003

Author:

Jim Crowell
Professional Computer Solutions [PCS]
URL: http://jFormTK.com/
E-Mail: JimCrowell@EMail.com

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

Field Summary

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

JPromptPhrase(java.lang.String promptPhraseList)
Constructor:

Method Summary

static java.lang.String[][]	getPhrasePairs() Get the 'phrasePairs' [][] String Array that contains the Phrase List Ordered Pairs.
void	setPromptPhraseList(java.lang.String promptPhraseListIn) Set the 'phrases[]' and the 'phrasePairs[][]' Class variables as a function of the given Prompt Phrase List [promptPhraseList] String...
void	showJPromptPhrase(java.lang.String from) Produce a Message Dialog Window to display the current phrase pairs of this 'JPromptPhrase' instance...

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JPromptPhrase

public JPromptPhrase(java.lang.String promptPhraseList)

Constructor:

Parameters:

promptPhraseList - Encoded Prompt Phrase List. [See 'Getting Started: AppCommonDB' Doc]

Method Detail

getPhrasePairs

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

Get the 'phrasePairs' [][] String Array that contains the Phrase List Ordered Pairs.

Returns:

[][] String Array.

setPromptPhraseList

public void setPromptPhraseList(java.lang.String promptPhraseListIn)

        Set the 'phrases[]' and the 'phrasePairs[][]' Class variables as a function of
        the given Prompt Phrase List [promptPhraseList] String...
        

Parameters:

promptPhraseListIn - Encoded Prompt Phrase List. [See 'Getting Started: AppCommonDB' Doc]

showJPromptPhrase

public void showJPromptPhrase(java.lang.String from)

Produce a Message Dialog Window to display the current phrase pairs of this 'JPromptPhrase' instance...

Parameters:

from - DEBUG annotation of the invoking Class / Method...