com.herewhite.sdk.domain.WindowDocsEvent Class Reference

Classes
class	Options

Public Member Functions
	WindowDocsEvent (String event)
	WindowDocsEvent (String event, Options options)
String	getEvent ()
void	setEvent (String event)
Options	getOptions ()
void	setOptions (Options options)

Static Public Member Functions
static WindowDocsEvent	JumpToPage (Integer page)

Static Public Attributes
static WindowDocsEvent	PrevPage = new WindowDocsEvent("prevPage")
static WindowDocsEvent	NextPage = new WindowDocsEvent("nextPage")
static WindowDocsEvent	PrevStep = new WindowDocsEvent("prevStep")
static WindowDocsEvent	NextStep = new WindowDocsEvent("nextStep")

Detailed Description

The WindowDocsEvent class. Used to define events for controling docs.

Constructor & Destructor Documentation

WindowDocsEvent()

com.herewhite.sdk.domain.WindowDocsEvent.WindowDocsEvent	(	String	event,
		Options	options
	)

Parameters

event	Docs event, including the following: prevPage: Previous page. nextPage: Next page. prevStep: Previous step. nextStep: Next step. jumpToPage: Jump to page.
options	The options of the event. Needed only when event is jumpToPage, specifying the target page you want to jump to.

Member Function Documentation

JumpToPage()

static WindowDocsEvent com.herewhite.sdk.domain.WindowDocsEvent.JumpToPage ( Integer  page )

static

Jumps to a specified page of a doc.

Parameters

page	The target page you want to jump to.

Member Data Documentation

PrevPage

WindowDocsEvent com.herewhite.sdk.domain.WindowDocsEvent.PrevPage = new WindowDocsEvent("prevPage")

static

Previous page.

NextPage

WindowDocsEvent com.herewhite.sdk.domain.WindowDocsEvent.NextPage = new WindowDocsEvent("nextPage")

static

Next page.

PrevStep

WindowDocsEvent com.herewhite.sdk.domain.WindowDocsEvent.PrevStep = new WindowDocsEvent("prevStep")

static

Previous step.

NextStep

WindowDocsEvent com.herewhite.sdk.domain.WindowDocsEvent.NextStep = new WindowDocsEvent("nextStep")

static

Next step.