This class displays a printer friendly version of the class definition. More...

Inheritance diagram for PrintClass:

[legend]

Collaboration diagram for PrintClass:

[legend]

Static Public Member Functions
	DrawUsername ()
	Draw username or server name depend on setup.

_.Library.Status	OnPage ()
	Event handler for PAGE event: this is invoked in order to More...

Static Public Member Functions inherited from Documatic
_.Library.Boolean	OnPreHTTP ()
	Write out any cookies we want to hold onto.

_.Library.Status	RenderClassPage (_.Library.ClassDefinition cdef, _.Library.Boolean private)
	Generate an HTML page for the class cdef.

	RenderCode (_.Library.CharacterStream streamIn, _.Library.String lang, _.Library.AbstractStream streamOut)
	Color the code in <PARAMETER>streamIn</PARAMETER> based on the language <PARAMETER>lang</PARAMETER> More...

	RenderDescription (_.Library.String thisclass, _.Library.String desc, _.Library.String starttag, _.Library.String endtag)
	Write a description string out as HTML. More...

_.Library.Status	RenderIndexPage (_, _.Library.String library, _.Library.String expand)
	Renders a library index page. More...

_.Library.Status	RenderNameSpaceList ()
	Generate HTML table showing available namespaces.

_.Library.Status	RenderNameSpacePage ()
	Generate an HTML page show information on the current namespace.

_.Library.Status	RenderPackageInfo (_.Library.String pTitle, _.Library.String packagename)
	Generate HTML table showing contents of the given package.

_.Library.Status	RenderPackagePage (_.Library.String packagename)
	Generate an HTML page for the package <PARAMETER>packagename</PARAMETER>.

_.Library.Status	RenderSQLStorageDef (_.Library.ClassDefinition cdef, sdef, ss, lbl)
	Generate an HTML page for the class cdef serial storage definition. More...

_.Library.Status	RenderStorageDef (_.Library.ClassDefinition cdef, _.Library.Boolean issuper)
	Generate an HTML page for the class cdef serial storage definition. More...

_.Library.Status	RenderStoragePage (_.Library.ClassDefinition cdef)
	Generate an HTML page for the class <PARAMETER>cdef</PARAMETER> storage definition.

Static Public Member Functions inherited from Page
_.Library.Status	ConvertParameter (_.Library.String url, _.Library.String name, _.Library.String value)
	You pass this the <parameter>url</parameter> of the page you are going to and a. More...

_.Library.Binary	Decrypt (_.Library.String data)
	Decrypts the input string using the session.Key value that is unique to. More...

_.Library.String	Encrypt (_.Library.Binary data)
	Encrypts the input string using the session.Key value that is unique to this. More...

_.Library.String	EscapeHTML (in)
	This method converts input HTML text into Escaped HTML text.

_.Library.String	EscapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in input URL string into Escaped URL string. More...

_.Library.String	HyperEventCall (_.Library.String methodName, _.Library.String args, _.Library.Integer type, _.Library.Boolean mobile)
	This method returns the string that needs to be written to the current. More...

_.Library.String	HyperEventHead (_.Library.Boolean iframeOnly, _.Library.Boolean strict, _.Library.Boolean optionalBroker)
	This method returns the string that needs to be written to the current. More...

	Include (_.Library.String url)
	Include another csp page or file in the output at this point. More...

_.Library.String	InsertHiddenField (_.Library.String url, _.Library.String name, _.Library.String value, _.Library.String extra)
	Inserts a '<input type="hidden" name="Name" value="Value">' tag into the current document. More...

_.Library.String	InsertHiddenFields (_.Library.String url, _.Library.String query)
	Return the string containing the hidden form tags. More...

_.Library.Boolean	IsPrivate ()
	Returns 1 if this page is in fact a private page (see <parameter>PRIVATE</parameter>).

_.Library.String	Link (_.Library.String link, _.Library.String query, _.Library.Boolean addQ)
	Tranforms the link specified by link into a URL and returns it as a string. More...

_.Library.Status	OnHTTPHeader (_.Library.Boolean OutputBody)
	Event handler for PAGE event: this is invoked in order to More...

	OnPageError (_.Library.Status sc)
	Event handler for any error that occurs on the page. More...

	OnPostHTTP ()
	Event handler for POSTPAGE event: this is invoked after the data. More...

_.Library.Status	OnPostHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked after a hyperevent method is called on this page.

_.Library.Status	OnPreHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked before a hyperevent method is called on this page. More...

_.Library.Status	Page (_.Library.Boolean skipheader)
	Process a request to serve a CSPPage. More...

_.Library.String	QuoteJS (in)
	This method converts input string into quoted JavaScript literal.

_.Library.String	RewriteURL (_.Library.String url)
	This method will rewrite a URL to use #url()# if needed.

	ShowError (_.Library.Status sc)
	Display a <class>Status</class> error code to the CSP Page.

	StartTimer (_.Library.String name)
	Used to get performance information on your CSP pages. More...

	StopTimer (_.Library.String name)
	Used to time performance information on your CSP pages. More...

	ThrowError (_.Library.Status sc)
	Passed a <class>Status</class> code this goes to the error page passing this status code.

_.Library.String	UnescapeHTML (in)
	This method converts Escaped HTML text into normal HTML text.

_.Library.String	UnescapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in Escaped URL string back to its original form. More...

Static Public Attributes
	CSPURL = None
	This class displays a printer friendly version of the class definition. More...

Static Public Attributes inherited from Documatic
	CSPURL = None
	This class is used internally by InterSystems IRIS. More...

	DOMAIN = None
	Default Localization Domain.

Static Public Attributes inherited from Page
	CHARSET = None
	The <CLASS>CSP.Page</CLASS> object serves as an event handler for CSP requests. More...

	CONTENTTYPE = None
	Specifies the default content type for the page. More...

	CONVERTINPUTSTREAM = None
	Specifies if input request.Content or request.MimeData values are converted from their. More...

	CSPFILE = None
	If this page was compiled from a .csp file, then this parameter contains the. More...

	CSPSTRICT = None
	The CSPSTRICT parameter is set to 1, if the DOCTYPE indicates that this. More...

	CSPURL = None
	This parameter is used to make sure that if multiple. More...

	CSPXHTML = None
	The CSPXHTML parameter is set to 1, if the DOCTYPE indicates that this. More...

	DOMAIN = None
	The default domain for csp:text, span and div tags. More...

	ENCODED = None
	Controls how the query parameters for this page are passed, it can. More...

	ERRORPAGE = None
	Specify a custom error page to call if there are any problems with generating this page. More...

	EXPIRES = None
	Specified the default value for the response.Expires. More...

	NOCHARSETCONVERT = None
	Specifies if we wish to turn off charset conversion for this page. More...

	PAGETIMING = None
	If this parameter is true then we automatically record timing statistics of how long it takes to. More...

	PRIVATE = None
	Controls the access to the page, it can be set to one of the following: More...

	SECURITYRESOURCE = None
	This is a comma-delimited list of system Resources and associated. More...

	TIMINGSLOTS = None
	Used by the timing to decide how many slots a day should be divided up into. More...

	UseSession = None
	This parameter controls the CSP session support. More...

Static Private Member Functions
_.Library.Status	__RenderBanner (_.Library.String title, _, _.Library.String library, _.Library.String class)
	Generate the title banner for the current page. More...

	__RenderPrinter ()
	Display Printer link.

_.Library.Status	__ServeStyleSheet ()
	Renders the style sheet used by the doc viewer.

Detailed Description

This class displays a printer friendly version of the class definition.

User may click the "print" link to choose printer, etc.
Other links are disabled except the section labels, such as "Summary", where user may click to collapse the label if they do not wish to print that section.

Member Function Documentation

◆ OnPage()

_.Library.Status OnPage ( )

static

Event handler for PAGE event: this is invoked in order to

display a csp page. This method is called to render a class document to a browser.

Reimplemented from Documatic.

◆ __RenderBanner()

_.Library.Status __RenderBanner	(	_.Library.String	title,
			_,
		_.Library.String	library,
		_.Library.String	class
	)

staticprivate

Generate the title banner for the current page.

pageType=0 means "we're displaying normal content", pageType=1 means "this is the Home page", pageType=2 means "this is the SearchPage page", pageType=3 means "this is the Getting Started page" pageType=4 means "this is the Master Index page"

Reimplemented from Documatic.

Member Data Documentation

◆ CSPURL

CSPURL = None