|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--Main
Defined in obj-main.js
Version: 1.0
Author: mpollack
Field Summary | |
Chapter |
chapter
Current Chapter Object reference |
Course |
course
Course Object reference |
GlobalTools |
globaltools
Global Tools Object reference |
Glossary |
glossary
Glossary Object reference |
string |
objname
Name given to identify object on debug |
Page |
page
Current Page Object reference |
Section |
section
Current Section Object reference |
Theme |
theme
Theme Object reference |
Topic |
topic
Current Topic Object reference |
Constructor Summary | |
Main()
The highest level object containing all data and methods for accessing data from a course or theme |
Method Summary | |
void
|
getCurrent()
sends the command to get the current page information |
void
|
gotoPage(<string> p)
Sends the go to page command passing the supplied LI number |
void
|
nextPage()
Sends the next page command |
void
|
previousPage()
Sends the previous page command |
void
|
setCurrentChapterByID(<string> i)
Sets the chapter from a supplied ID |
void
|
setCurrentPageByID(<string> i)
Sets the page from a supplied ID and if the page set does not have page text set, the call is made to get that text. |
void
|
setCurrentSectionByID(<string> i)
Sets the section from a supplied ID |
void
|
setCurrentTopicByID(<string> i)
Sets the topic from a supplied ID |
void
|
setData(<string> d)
Sets data on the object using a delimited string sent via the jshook api. |
void
|
toggle()
Toggles from the current language to the secondary language and refreshes the data and theme |
Field Detail |
Chapter chapter
Course course
GlobalTools globaltools
Glossary glossary
string objname
Page page
Section section
Theme theme
Topic topic
Constructor Detail |
Main()
Method Detail |
void getCurrent()
void gotoPage(<string> p)
p
- "." delimited LI number for the page to be navigated to, ex "1.2.3.4"
void nextPage()
void previousPage()
void setCurrentChapterByID(<string> i)
i
- chapter id
void setCurrentPageByID(<string> i)
i
- page id
void setCurrentSectionByID(<string> i)
i
- section id
void setCurrentTopicByID(<string> i)
i
- topic id
void setData(<string> d)
d
- delimited string with js commands
void toggle()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |