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

## Class GlossaryTerm

    Object
       |
       +--GlossaryTerm

class GlossaryTerm

Defined in obj-glossaryterm.js
Version: 1.0
Author: mpollack

Field Summary
`string` | `definition` Glossary term definition
`string` | `id` Glossary term id
`string` | `objname` Name given to identify object on debug
`Glossary` | `par` Reference to parent object
`array` | `seealso` Array of glossary term ids this term is to reference
`string` | `setID` ID of glossary set term belongs in
`string` | `term` Glossary term string

Constructor Summary
`GlossaryTerm(&l<string> t;Glossary> p,t,<string> d,<string> i,<string> s,<string> sa)` Holds information for glossary term

Method Summary
`void` | `dump()` Sends debug information on term properties to the debug window if turned on
`void` | `setData(<string> d)` Sets data on the object using a delimited string sent via the jshook api.
`array` | `setSeeAlso(<string> r)` Converts comma delimited string of glossary ids to an array

Field Detail

### definition

    string definition

Glossary term definition

### id

    string id

Glossary term id

### objname

    string objname

Name given to identify object on debug

### par

    Glossary par

Reference to parent object

### seealso

    array seealso

Array of glossary term ids this term is to reference

### setID

    string setID

ID of glossary set term belongs in

### term

    string term

Glossary term string

Constructor Detail

### GlossaryTerm

    GlossaryTerm(&l<string> t;Glossary> p,t,<string> d,<string> i,<string> s,<string> sa)

Holds information for glossary term

Parameters:

`p` - parent object reference

`t` - term

`d` - definition

`i` - term id

`s` - set id

`sa` - see also terms

Version: 1.0
Author: mpollack

Method Detail

### dump

    void dump()

Sends debug information on term properties to the debug window if turned on

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

### setSeeAlso

    array setSeeAlso(<string> r)

Converts comma delimited string of glossary ids to an array

Parameters:

`r` - delimited string of glossary term ids

Returns:

glossary term ids

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