DEPRECATED: DiffusionTM JavaScript Classic API
5.9.4

Classes

Class PagedTopicHandler


Paged topic handler.

This allows the page view to be controlled. It can be used to send messages to change the view. The responses may cause a PagedTopicListener callback to be invoked.


Fields Summary

PageStatus currentStatus
The most recent status received by the handler
Boolean isOpen
If a page is currently open

Constructor Summary

PagedTopicHandler PagedTopicHandler

Method Summary

null close()
Closes the view of the paged topic.
null first()
Changes the view to the first page of the topic.
null last()
Changes the view to the last page of the topic.
null next()
Changes the view to the next page of the topic.
null open(lines, page)
Opens a view of the paged topic.
null page(page)
Selects a page to open in the current view.
null prior()
Changes the view to the previous page of the topic.
null refresh()
Refreshes the view of the current page of the topic.

Constructor Details

PagedTopicHandler

PagedTopicHandler PagedTopicHandler

Parameters
topicLoad - Topic load message
listener - The listener for the handler
Since:
5.0

Field Details

currentStatus

PageStatus currentStatus

The most recent status received by the handler


isOpen

Boolean isOpen

If a page is currently open


Method Details

close

close()

Closes the view of the paged topic. A new view can be opened once the view is closed.

Since:
5.0

first

first()

Changes the view to the first page of the topic.

Since:
5.0

last

last()

Changes the view to the last page of the topic.

Since:
5.0

next

next()

Changes the view to the next page of the topic.

Since:
5.0

open

open(lines, page)

Opens a view of the paged topic.

Parameters
lines - The number of lines on each page
page - The page to view first
Since:
5.0

page

page(page)

Selects a page to open in the current view. Throws a TypeError if page is not and cannot be parsed into a number.

Parameters
page - The page to go to
Since:
5.0

prior

prior()

Changes the view to the previous page of the topic.

Since:
5.0

refresh

refresh()

Refreshes the view of the current page of the topic.

Since:
5.0