|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Object | +--Glossary
Defined in obj-glossary.js
Version: 1.0 &
Author: mpollack
| Field Summary | |
string |
objname
Name given to identify object on debug |
Main |
par
Reference to parent object |
array |
sets
Glossary sets in sequential array |
array |
setsID
Glossary sets in associative array |
array |
terms
Glossary terms in sequential array |
array |
termsID
Glossary terms in associative array |
| Constructor Summary | |
Glossary(<Main> p)
Holds all glossary terms, sets and access controls |
|
| Method Summary | |
void
|
addSet(<string> sk, <string> sl)
Adds a set object to the set arrays |
void
|
addTerm(<string> t, <string> d, <string> i, <string> s, <string> sa)
Adds a term object to the term arrays and if the set exists adds that term to the term array of the set |
void
|
dump()
Sends debug information on glossary, sets and terms to the debug window if turned on |
void
|
getData()
sends the command to get the glossary data |
GlossarySet
|
getSetByID(<string> i)
Returns a set object based on set id or an error string if the id is invalid |
GlossaryTerm
|
getTermByID(<string> i)
Returns a term object based on set id or an error string if the id is invalid |
void
|
setData(<string> d)
Sets data on the object using a delimited string sent via the jshook api. |
| Field Detail |
string objname
Main par
array sets
array setsID
array terms
array termsID
| Constructor Detail |
Glossary(<Main> p)
p - parent object reference
| Method Detail |
void addSet(<string> sk, <string> sl)
sk - set key
sl - set label
void addTerm(<string> t, <string> d, <string> i, <string> s, <string> sa)
t - term
d - definition
i - term id
s - set id
sa - see also terms
void dump()
void getData()
GlossarySet getSetByID(<string> i)
i - set id
GlossaryTerm getTermByID(<string> i)
i - term id
void setData(<string> d)
d - delimited string with js commands
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||