Class Glossary

Object
   |
   +--Glossary

class 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

objname

string objname

par

Main par

sets

array sets

setsID

array setsID

terms

array terms

termsID

array termsID

Constructor Detail

Glossary

Glossary(<Main> p)

Method Detail

addSet

void addSet(<string> sk, <string> sl)

addTerm

void addTerm(<string> t, <string> d, <string> i, <string> s, <string> sa)

dump

void dump()

getData

void getData()

getSetByID

GlossarySet getSetByID(<string> i)

getTermByID

GlossaryTerm getTermByID(<string> i)

setData

void setData(<string> d)


Documentation generated by JSDoc on Tue Mar 4 12:01:48 2008