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

## Class Section

    Object
       |
       +--Section

class Section

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

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

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

Method Summary
`Boolean` | `containsMediaByFilter(<string> f)` Checks the section 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
`Topic` | `getTopicByID(<string> i)` Gets the topic from a supplied ID

Field Detail

### num

    string num

Section number

### objname

    string objname

Name given to identify object on debug

### oid

    string oid

Section ID

### par

    Chapter par

Reference to parent object

### title

    string title

Section title

### topics

    array topics

Topic objects in a sequential array

### topicsID

    array topicsID

Topic objects in an associative array

### type

    string type

Section type

Constructor Detail

### Section

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

Contains data for a section

Parameters:

`p` - parent object reference

`id` - section ID

`ti` - section title

`ty` - section type

`nu` - section number

Version: 1.0
Author: mpollack

Method Detail

### containsMediaByFilter

    Boolean containsMediaByFilter(<string> f)

Checks the section 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

### getTopicByID

    Topic getTopicByID(<string> i)

Gets the topic from a supplied ID

Parameters:

`i` - topic id

Returns:

A Topic 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