com.jFormTK
Class JMessagePhrase

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

public class JMessagePhrase
extends java.lang.Object
implements JConstants

        This 'jFormTK' class is designed to contain the 'JMessage' Class Phrase Controls to 
        be used to "Style" the message created by the 'jFormTK.JMessage' Class during the 
        'jFormTK' Application run -time execution phase...
 
        These controls are defaulted by the 'jFormTK.Main' Class but they may be initialized
        by the 'jFormTK' Developer by adding "messagePhraseList" element to the AppCopmmonDB
        via an override of the 'loadAppCommonDB_Ordered_Pairs' Method in your Application's
        'jFormTK.Main' Sub-Class, i.e. your Application Main Task [e.g.'JFormTKMain' in the
        PCS test suite]...

        Each Phrase Set is delimited by the 'JFormTKDB.itemsDelimiter.
        Each Phrase has the following Fields separated by the 'jFormTKDB.groupSaveDelimiter':
        1)      Phrase String, i.e. the Phrase to search for in each Phrase...
        2)      {Optional}Encoded 'JLAF' for the Associated 'Phrase String'...

        If no 'encodedJLAF' is given the 'jFormTK' Kernel SHALL use the
                'jFormTKDB.messagePhraseLAF' instance to control the matching 
                Phrased Look And Feel...
 [See 'Getting Started: AppCommonDB' Doc]
 [See 'messagePhraseList' Doc]
 
        NOTE:
        The Message Pharases SHALL be "Dynamic", i.e. any control may be modified during
        Run-Time via this Class.

        Kernel Usage:
        1)      Instanced by the 'jFormTK.Main.java' Class iff the 'AppCommonDB'
                'messagePhraseList' Element is NOT Null [i.e. there are Message Phrases to be
                Styled for this Application and the 'AppCommonDB' contains a NON 'null'
                'messagePhraseList' element...

        2)      The 'JMessage.setStyle' method uses this class when construction a Message for
                presentation to the 'jFormTK' Application End-User...
 

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

Copyright (c) 2006 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
JMessagePhrase(java.lang.String messagePhraseList)
           Constructor.
 
Method Summary
static java.lang.String[][] getPhrasePairs()
           Return the 'phrasePairs' [][] String Array...
 void setMessagePhraseList(java.lang.String messagePhraseListIn)
           
static void showJMessagePhrase(java.lang.String from)
           Show the current contents of the 'phases' and phrasePairs array in a JFormFrame.message Window...
static void XXXshowJMessagePhrase(java.lang.String[][] phrasePairs, java.lang.String from)
           Show the current contents of the 'phases' array and the given Phrase pairs Array in a JFormFrame.message Window...
 java.lang.String XXXtoString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JMessagePhrase

public JMessagePhrase(java.lang.String messagePhraseList)
        Constructor.
        Set the phrases[] and phrasePairs[][] arrays as a function of the
        given Message Phrase String...

        Kernel Usage:
        1)      'Main.init' iff the derived Message Phrase List is NOT Null...
        

Parameters:
messagePhraseList - Message Phrase String...
Method Detail

getPhrasePairs

public static java.lang.String[][] getPhrasePairs()
        Return the 'phrasePairs' [][] String Array...

        Kernel Usage:
        1)      'Util.buildStyledMessage' Method to convert the packed 'JFormField' Message
                to the Styled Message String...
        

Returns:
the 'phrasePairs' [][] String Array...

setMessagePhraseList

public void setMessagePhraseList(java.lang.String messagePhraseListIn)

XXXshowJMessagePhrase

public static void XXXshowJMessagePhrase(java.lang.String[][] phrasePairs,
                                         java.lang.String from)
        Show the current contents of the 'phases' array and the given Phrase pairs
        Array in a JFormFrame.message Window...
        

Parameters:
from - Annotation String to define the calling method / event...

showJMessagePhrase

public static void showJMessagePhrase(java.lang.String from)
        Show the current contents of the 'phases' and phrasePairs array in a
        JFormFrame.message Window...
        

Parameters:
from - Annotation String to define the calling method / event...

XXXtoString

public java.lang.String XXXtoString()