com.jFormTK
Class JRunTime

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

public class JRunTime
extends java.lang.Object
implements JConstants

This Java Form Tool Kit [jFormTK] Class is designed to contain the Run-Time parameters for the following dynamic processing: 'PreProcessor' 'PostProcessor' 'doButton' 'preAssignment', 'postAssignment' 'preIfAssignment', postIFAssignment' [inclused Else clause if required] This class is used exclusively in the 'JFormField' constructors and is designed to push the PreProcessor, PostProcessor, doButton, assignment, ifAssignment and ifElseAssignment operations into the 'jFormTK' Kernel so that most functionality can be driven by script files. If the usage of this class is insufficient for your 'jFormTK' Application requirements, the 'JFormForm' Sub-Class override methods [preProcessor, postProcessor, doButton] may be applied to provide a Java code solution for your requirements. This container class also contains the 'recurrence' and 'overwrite' flags to be applied to the specified Rub-Time operations. Recall that the 'recurrence' flag is a way to specify if the Run-Time operation shall be performed ONLY ONCE [default] or everytime the specified operation occurs. Recurrence flags are applied for each pre / post process operation and for each assignment phase [i.e. control, if, else]... The following controls are provided via constructors and implemented by the 'jFormTK' kernel: 1) type Processing type String starting with the following characters: "pre", "post", "doB", "asPre","asPost","asPreIf","asPostIF"... 2) flag a) If the 'type' is "pre", "post" or "doB": The PreProcessor or PostProcessor control boolean... OR 'Null' if b) If the 'type' is "asPre","asPost","asPreIf" or "asPostIF": This field is not used and will be set to 'Null' By the constructors. 3) object a) If the 'type' is "pre", "post" or "doB": The Object component [variant] used for 'preProcessor', or 'postProcessor'. Not always required. b) If the 'type' is "asPre","asPost","asPreIf" or "asPostIF": This field is not used and will be set to 'Null' By the constructors. 4) script This element contains the control script to be processed by the Run-Time kernel = f[type]... a) If the 'type' is "pre", "post" or "doB": The name of the 'Util' class method to be invoked during Run-Time when the operation indicated by the 'type' control occurs. If this 'script' contains the 'Null' String [i.e. == ""], Then the associated processing is performed by the JFormForm Sub-Class 'preProcessor', 'postProcessor' or 'doButton' OVERRIDE methods. This is designed to allow the Java aware 'jFormTK' developer to code any solutions not handled by the 'Util' class abstract methods. b) If the 'type' is "asPre","asPost","asPreIf" or "asPostIF": The script shall contain one or more assignment statements. Multiple assignments are delimited by the 'JFormTKDB.fieldsDelimiter. For the Pre OR Post assignments 'type' [i.e. "asPre","asPost"], the assignment statement contains the "A = B op C" form where A, B and C may contain Run-Time references to a 'JFormField' elements [using 'jFormTK' Field ID syntax], an AppDB values, a CommonDB elements or a constants. The 'op' is the allowed operation code [i.e. +. -, *, /]. For the conditional If assignments [i.e. "asPreIf" or "asPostIF"], each Run-Time assignment statement contains two or three fields delimited by a comma. The fields are the 'If condition', the 'If' assignment formula and [if required] the 'Else' assignment formula. Again the A, B, C fields are constructed as described above. c) If the 'type' is "ab": Contains the 'addToAddressBook' signatures as follows with a COMMA parameter delimiter: 1) type - AddressBook 'type' field... 2) nameID - the JFormField ID to fetch the new JAddressBook Entry 'name' value... typeID - the JFormField ID to fetch the new JAddressBook Entry 'type' value... 3) nameID - the JFormField ID to fetch the new JAddressBook Entry 'name' value... typeID - the JFormField ID to fetch the new JAddressBook Entry 'type' value... type - the 'Type' field value of the new JAddressBook Entry... 5) recurrence a) If the 'type' is "pre", "post", "asPre","asPost": A single 'recurrence' Flag is used. The default is a boolean false. This parameter uses a String because the assignment If condition may have 2 flags. b) If the 'type' is "asPreIf" or "asPostIF": There is a 'recurrence' flag for the "If" statement formula and [iff required] there is a 'recurrence' flag for the Else statement formula. String format: True: "t" OR "true" case insensitive. False: "f" OR "false" case insensitive. Multi flags delimiter is a comma. Exammple 1: "t,t" == "t,T" == "T,T" == "true,true" == "t,True", etc... Exammple 2: "f,f" == "F,f" == "F,F" == "false,false", etc... 6) Overwrite This flag controls the overwrite of the assignment 'A' field if the 'A' field is NOT Null. By default 'overwrite' is false so that once a field has been set by the end user or via a dynamic run-time assignment is shall not be over written. If the 'jFormTK' developer wants to allow the overwrite, Then the developer can set 'overwrite' to true... String format: Same as in 'recurrence' above except there is only one overwrite control per 'JFormField'...

Version:
1.00, 30 Oct 2008
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
 
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
JRunTime(java.lang.String overwrite)
           
JRunTime(java.lang.String type, boolean flag, java.lang.Object object, java.lang.String script)
           
JRunTime(java.lang.String type, boolean flag, java.lang.Object object, java.lang.String script, java.lang.String recurrence)
           
JRunTime(java.lang.String type, boolean flag, java.lang.Object object, java.lang.String script, java.lang.String recurrence, java.lang.String overwrite)
           
JRunTime(java.lang.String type, boolean flag, java.lang.String script)
           
JRunTime(java.lang.String type, boolean flag, java.lang.String script, java.lang.String recurrence)
           
JRunTime(java.lang.String type, boolean flag, java.lang.String script, java.lang.String recurrence, java.lang.String overwrite)
           
JRunTime(java.lang.String type, java.lang.String recurrence)
           
JRunTime(java.lang.String type, java.lang.String recurrence, java.lang.String overwrite)
           
 
Method Summary
 java.lang.String displayJRunTime()
           
 boolean getFlag()
           
 java.lang.Object getObject()
           
 java.lang.String getOverwrite()
           
 java.lang.String getRecurrence()
           
 java.lang.String[] getRTimesTypes()
           
 java.lang.String getScript()
           
 int getType()
           
 boolean isFlag()
           
 void setFlag(boolean flag)
           
 void setObject(java.lang.Object object)
           
 void setOverwrite(java.lang.String overwrite)
           
 void setRecurrence(java.lang.String recurrence)
           
 void setScript(java.lang.String script)
           
 void setType(int type)
           
 void showJRunTime()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JRunTime

JRunTime(java.lang.String type,
         boolean flag,
         java.lang.Object object,
         java.lang.String script)

JRunTime

JRunTime(java.lang.String type,
         boolean flag,
         java.lang.String script)

JRunTime

JRunTime(java.lang.String type,
         boolean flag,
         java.lang.Object object,
         java.lang.String script,
         java.lang.String recurrence)

JRunTime

JRunTime(java.lang.String type,
         boolean flag,
         java.lang.String script,
         java.lang.String recurrence)

JRunTime

JRunTime(java.lang.String type,
         boolean flag,
         java.lang.Object object,
         java.lang.String script,
         java.lang.String recurrence,
         java.lang.String overwrite)

JRunTime

JRunTime(java.lang.String type,
         boolean flag,
         java.lang.String script,
         java.lang.String recurrence,
         java.lang.String overwrite)

JRunTime

JRunTime(java.lang.String type,
         java.lang.String recurrence)

JRunTime

JRunTime(java.lang.String type,
         java.lang.String recurrence,
         java.lang.String overwrite)

JRunTime

JRunTime(java.lang.String overwrite)
Method Detail

displayJRunTime

public java.lang.String displayJRunTime()

getFlag

public boolean getFlag()
Returns:
Returns the flag.

getObject

public java.lang.Object getObject()
Returns:
Returns the object.

getOverwrite

public java.lang.String getOverwrite()
Returns:
Returns the overwrite String.

getRecurrence

public java.lang.String getRecurrence()
Returns:
Returns the recurrence String.

getScript

public java.lang.String getScript()
Returns:
Returns the script.

getType

public int getType()
Returns:
Returns the type.

isFlag

public boolean isFlag()
Returns:
Returns the flag.

getRTimesTypes

public java.lang.String[] getRTimesTypes()
Returns:
'rTimesTypes' String array...

setFlag

public void setFlag(boolean flag)
Parameters:
flag - The flag to set.

setObject

public void setObject(java.lang.Object object)
Parameters:
object - The object to set.

setOverwrite

public void setOverwrite(java.lang.String overwrite)
Parameters:
overwrite - The overwrite String to set 'overwrite' to...

setRecurrence

public void setRecurrence(java.lang.String recurrence)
Parameters:
recurrence - The String to set 'recurrence' to...

setScript

public void setScript(java.lang.String script)
Parameters:
script - The script to set.

setType

public void setType(int type)
Parameters:
type - The type to set.

showJRunTime

public void showJRunTime()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object