com.jFormTK.JAddressBookControl
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class JAddressBookControl
This 'jFormTK' Class is used to contain a set of "Control" parameters assigned to
a given individual in the 'JAddressBook' TreeMap. Each 'JAddressBook' TreeMap
ordered pair contains a Name Key and an instance of this 'jFormTK' Class...
The "Control" parameters are as follows:
1) 'masterKeys' encoded String of up to 4 TreeMap Keys...
2) 'personName' String...
3) 'sameAsMasterKey' String...
1) JAddressBook 'types' ArrayList...
2) JAddressBook 'anchors' ArrayList...
3) 'JContactInfo' instance...
4) 'JPersonalInfo' instance...
Each time a new individual is to be added to the 'jFormTK.JAddressBook' the
persons name key is provided. This key is generally established via the
'JFormField._PField' type. The following fields are entered and verified by
the Form Data Entry person:
- Given Name
- NickName
- Middle
- SurName
- Maiden Name
- Suffix
- Roman Numeral
The verified fields [see VerifyABKey Class] are used to construct the new person
'JAddressBook' TreeMap Keys via the 'JAddressBook.buildJAddressBookKey' method.
This method constructs from 1 to 4 keys as follows:
masterKey, slaveKey, maidenMasterKey, maidenSlaveKey
[See 'buildJAddressBookKey' prologue for detailed explanation]...
The 'JAddressBook' TreeMap has ordered pair entries as follows:
'masterKey' , 'this.JAddressBookControl' instance...
'slaveKey' , 'masterKey' pointer...
'maidenMasterKey' , 'masterKey' pointer...
'maidenSlaveKey' , 'masterKey' pointer...
Kernel Usage:
There shall be an instance of this class for each person in the 'jFormTK'
Address Book in the 'jFormTK' Application. An instance is created when a NEW
person name is entered via the 'JFormField._PField' Form field. At that time a
'JAddressBook' entry type and 'JFormForm.Sub-Class' Anchor is given. When a NEW
person is added to the 'JAddresBook' TreeMap the 'JContactInfo' and 'JPersonalInfo'
fields are set to a 'Null'...
In most applications the _PField is followed by the _CIField which gathers the
Contact Information from the data entry end user. The _CIField built-in post
processor is then used to add the constructed 'JControlInfo' instance to the
proper 'JAddressBookControl' instance of the 'JAddressBook' TreeMap.
If the 'JPersonalInfo' Class is used in the 'jFormTK' Application a similar
proocess is used for data entry and 'JAddressBookControl' updating...
| 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 | |
|---|---|
JAddressBookControl(java.lang.String type,
java.lang.String anchor)
|
|
| Method Summary | |
|---|---|
void |
addJContactInfo(JContactInfo ciIn)
Add OR replace the current 'JContactInfo' instance [ci] with the given 'JContactInfo' instance... |
void |
addTypeAnchor(java.lang.String type,
java.lang.String anchor)
Add a Type /Anchor Ordered Pair to the existing 'types' / 'anchors' Array List... |
java.lang.String |
displayJAddressBookControl()
|
java.util.ArrayList |
getAnchors()
|
java.lang.String |
getAnchorsEncodedString()
|
JContactInfo |
getContactInfo()
|
java.lang.String |
getEncodedKeys()
|
java.lang.String |
getMasterKey()
|
JPersonalInfo |
getPersonalInfo()
|
java.lang.String |
getPersonName()
|
java.lang.String |
getSameAsMasterKey()
|
java.util.ArrayList |
getTypes()
|
java.lang.String |
getTypesEncodedString()
|
void |
setKeys(java.lang.String masterKey,
java.lang.String encodedKeys)
Set the 'masterKey' and the encoded TreeMap Keys for this Address Book Control instance... |
void |
setPersonName(java.lang.String personName)
|
boolean |
setSameAsMasterKey(java.lang.String sameAsMasterKey)
If the given Master Key is NOT null and is different than this instances 'masterKey' Then Set the 'this.sameAsMasterKey' control... |
void |
showJAddressBookControl(java.lang.String title)
|
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public JAddressBookControl(java.lang.String type,
java.lang.String anchor)
| Method Detail |
|---|
public void addJContactInfo(JContactInfo ciIn)
Add OR replace the current 'JContactInfo' instance [ci] with the
given 'JContactInfo' instance...
Kernel Usage:
1) 'JFormForm.Sub-Class' Form classes via the 'JFormField._CIField' field...
NOTE: a ctual invoking method is the 'JFormField.TBD' method...
ciIn - The 'JContactInfo' instance to be assigned to this
'JAddressBookControl' instance...
public void addTypeAnchor(java.lang.String type,
java.lang.String anchor)
Add a Type /Anchor Ordered Pair to the existing 'types' / 'anchors'
Array List...
Kernel Usage:
1) 'TBD'...
type - anchor - public java.lang.String displayJAddressBookControl()
public java.util.ArrayList getAnchors()
public java.lang.String getAnchorsEncodedString()
public JContactInfo getContactInfo()
public java.lang.String getEncodedKeys()
public java.lang.String getMasterKey()
public JPersonalInfo getPersonalInfo()
public java.lang.String getPersonName()
public java.lang.String getSameAsMasterKey()
public java.util.ArrayList getTypes()
public java.lang.String getTypesEncodedString()
public void setKeys(java.lang.String masterKey,
java.lang.String encodedKeys)
Set the 'masterKey' and the encoded TreeMap Keys for this
Address Book Control instance...
Kernel Usage:
1) 'JAddressBook.addKeys' method...
masterKey - The Master Key [String] for this Address Book Person...encodedKeys - The encoded Keys [String,D_ITEMS] used in the
Tree Map construction...public void setPersonName(java.lang.String personName)
personName - The personName to set.public boolean setSameAsMasterKey(java.lang.String sameAsMasterKey)
If the given Master Key is NOT null and is different than this instances
'masterKey'
Then
Set the 'this.sameAsMasterKey' control...
Else produce a warning to the 'jFormTK' Application End user
and ignore the given 'sameAsMasterKey'...
Kernel Usage:
1) 'JAddressBookDialog.JAddressBookDialog.ActionListener.actionPerformed'
after the End User selects the "Load" Check Box...
sameAsMasterKey - The sameAsMasterKey [String] to set.public void showJAddressBookControl(java.lang.String title)
public java.lang.String toString()
toString in class java.lang.Object
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||