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

## Class Topic

    Object
       |
       +--Topic

class Topic

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

Field Summary
`int` | `num` Topic number
`string` | `objname` Name given to identify object on debug
`string` | `oid` Topic ID
`array` | `pages` Page objects in a sequential array
`array` | `pagesID` Topic objects in an associative array
`Section` | `par` Reference to parent object
`string` | `title` Topic title
`string` | `type` Topic type

Constructor Summary
`Topic(<Section> p,<string> id,<string> ti,<string> ty,<int> nu)` Contains data for a topic

Method Summary
`Boolean` | `containsMediaByFilter(<string> f)` Checks the topic to see if any pages furth down the tree contain media of a particular type
`void` | `dump()` Sends debug information on all properties to the debug window
`Page` | `getPageByID(<string> i)` Gets the page from a supplied ID

Field Detail

### num

    int num

Topic number

### objname

    string objname

Name given to identify object on debug

### oid

    string oid

Topic ID

### pages

    array pages

Page objects in a sequential array

### pagesID

    array pagesID

Topic objects in an associative array

### par

    Section par

Reference to parent object

### title

    string title

Topic title

### type

    string type

Topic type

Constructor Detail

### Topic

    Topic(<Section> p,<string> id,<string> ti,<string> ty,<int> nu)

Contains data for a topic

Parameters:

`p` - parent object reference

`id` - topic ID

`ti` - topic title

`ty` - topic type

`nu` - topic number

Version: 1.0
Author: mpollack

Method Detail

### containsMediaByFilter

    Boolean containsMediaByFilter(<string> f)

Checks the topic to see if any pages furth down the tree contain media of a particular type

Parameters:

`f` - media filter type

Returns:

boolean

### dump

    void dump()

Sends debug information on all properties to the debug window

### getPageByID

    Page getPageByID(<string> i)

Gets the page from a supplied ID

Parameters:

`i` - page id

Returns:

A Page instance

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