Overview | File | Class | Tree | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## 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

Name given to identify object on debug

### par

    Main par

Reference to parent object

### sets

    array sets

Glossary sets in sequential array

### setsID

    array setsID

Glossary sets in associative array

### terms

    array terms

Glossary terms in sequential array

### termsID

    array termsID

Glossary terms in associative array

Constructor Detail

### Glossary

    Glossary(<Main> p)

Holds all glossary terms, sets and access controls

Parameters:

`p` - parent object reference

Version: 1.0 &
Author: mpollack

Method Detail

### addSet

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

Adds a set object to the set arrays

Parameters:

`sk` - set key

`sl` - set label

### addTerm

    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

Parameters:

`t` - term

`d` - definition

`i` - term id

`s` - set id

`sa` - see also terms

### dump

    void dump()

Sends debug information on glossary, sets and terms to the debug window if turned on

### getData

    void getData()

sends the command to get the glossary data

### getSetByID

    GlossarySet getSetByID(<string> i)

Returns a set object based on set id or an error string if the id is invalid

Parameters:

`i` - set id

Returns:

GlossarySet object reference

### getTermByID

    GlossaryTerm getTermByID(<string> i)

Returns a term object based on set id or an error string if the id is invalid

Parameters:

`i` - term id

Returns:

GlossaryTerm object reference

### setData

    void setData(<string> d)

Sets data on the object using a delimited string sent via the jshook api. The string is split and each entry is run through eval() to execute.

Parameters:

`d` - delimited string with js commands

Overview | File | Class | Tree | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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