IStateHandler Class Reference

Interface of StateHandler. More...

Inherited by CreatPredefinedTextStateHandler, EraserStateHandler, LoupeStateHandler, and LoupeStateHandler.

Public Member Functions
	destroyDocHandler ()
	Executed when the document is destroyed.
	destroyPageHandler ()
	docHandler (pdfDocRender)
	Binding at the document level. More...
	out ()
	This method is executed when it leaves the current stateHandler.
	pageHandler (pdfPageRender)
	Binding at the page level. More...

Static Public Member Functions
static	getStateName ()
	The name of the state handler, also a unique identifier. More...
static	setParams (params)
	This function is called by StateHandlerManager.switchTo, and processes parameters that were passed in.. More...

Detailed Description

Interface of StateHandler.

Member Function Documentation

destroyPageHandler()

IStateHandler::destroyPageHandler ( )

inline

Executed when the page is destroyed

docHandler()

IStateHandler::docHandler (   pdfDocRender )

inline

Binding at the document level.

Parameters

pdfDocRender

{PDFDocRender} - PDFDocRender

getStateName()

static IStateHandler::getStateName ( )

inlinestatic

The name of the state handler, also a unique identifier.

Returns

{string}

pageHandler()

IStateHandler::pageHandler (   pdfPageRender )

inline

Binding at the page level.

Parameters

pdfPageRender

{PDFPageRender} - PDFPageRender

setParams()

static IStateHandler::setParams (   params )

inlinestatic

This function is called by StateHandlerManager.switchTo, and processes parameters that were passed in..

Parameters

params

{object} - Parameters come from second parameter of StateHandlerManager.switchTo.