This class is used internally by InterSystems IRIS. More...

Inheritance diagram for AutoPage:

[legend]

Collaboration diagram for AutoPage:

[legend]

Static Public Member Functions
_.Library.String	ChangeNamespace (_.Library.String ns, _.Library.String mode)
	Go to specified namespace. More...

_.CSP.Util.PageInstance	CreatePageInstance (_.Library.String pID)
	Create the page instance object.

	DrawAutoLogout ()
	Write JavaScript to automatically logout out this page.

	DrawBODY (_.CSP.Util.PageInstance pInstance)
	Draw the BODY section for this page. More...

	DrawFrameBODY (_.CSP.Util.PageInstance pInstance, _.Library.String pFrame)
	Draw the BODY section for a specific pane as a frame.

	DrawFrameLayout ()
	Write JavaScript to manage size of frames.

_.Library.Status	DrawFrameSet (_.CSP.Util.PageInstance pInstance)
	Draw frameset for this page (if appropriate)

	DrawHEAD (_.CSP.Util.PageInstance pInstance, _.Library.String pFrame)
	Draw the HEAD section for this page (or frame)

_.Library.Status	DrawHTML ()
	Draw HTML for this CSP page.

	DrawShowDoc ()
	Write JavaScript for displaying documentation. More...

_.Library.Status	DrawTitle (_.Library.String tTitle)
	Called by CSP Action pages to draw the page header.

_.Library.String	GetCSPClassName (_.Library.String pURL)
	For a given CSP page name, return the actual class name;. More...

_.CSP.Util.Pane	GetDetailPane (_.CSP.Util.PageInstance pInstance)
	Get the detail pane info object.

_.CSP.Util.Pane	GetInfoPane (_.CSP.Util.PageInstance pInstance)
	Get the info pane info object.

	GetLocator (_.CSP.Util.TitlePane pTitlePane, _.Library.String pAddress)
	Get the list of items for the locator bar as well as the page address.

_.CSP.Util.Pane	GetNavigatorPane (_.CSP.Util.PageInstance pInstance)
	Get the navigator pane info object.

_.Library.String	GetPageName ()
	Return localized version of PageName.

_.CSP.Util.Pane	GetTitlePane (_.CSP.Util.PageInstance pInstance)
	Get the title pane info object.

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

_.Library.Boolean	OnPreHTTP ()
	Event handler for PreHTTP event: this is invoked before. More...

_.Library.Status	SetNamespace (_.Library.String ns)
	This utility method actually changes namespaces. More...

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
	AUTOLOGOUT = None
	This class is used internally by InterSystems IRIS. More...

	CHARSET = None
	Default charset.

	DOMAIN = None
	Default Localization Domain.

	FAVORITEICON = None
	SMP favorite icon.

	HYPEREVENTS = None
	If true, this page uses hyper-events (#call)

	IFRAMEALLOWED = None
	Allow pages to have iframes by not setting x-frame-options: same origin. More...

	PAGENAME = None
	Name of this page.

	PARENTPAGE = None
	Name of the parent page (used for the locator bar)

	STYLESHEET = None
	Name of the external style sheet file.

	USEFRAMES = None
	If true, this page uses frames.

	USENAMESPACE = None
	If true, this page changes namespace.

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...

Detailed Description

This class is used internally by InterSystems IRIS.

You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

A specialized CSP page that automatically displays a page based on information provided by a subclass.

Member Function Documentation

◆ ChangeNamespace()

_.Library.String ChangeNamespace	(	_.Library.String	ns,
		_.Library.String	mode
	)

static

Go to specified namespace.

Use "" to find a default namespace. Return namespace we actually tried to go to.

◆ DrawBODY()

DrawBODY ( _.CSP.Util.PageInstance pInstance )

static

Draw the BODY section for this page.

This consists of a number of "panes"

Reimplemented in AutoPagePopup.

◆ DrawShowDoc()

DrawShowDoc ( )

static

Write JavaScript for displaying documentation.

(Called directly from CSPX.AutoPageCSP.)

◆ GetCSPClassName()

_.Library.String GetCSPClassName ( _.Library.String pURL )

static

For a given CSP page name, return the actual class name;.

This method will normalize page names that do not have an application in their URL.

◆ OnPage()

_.Library.Status OnPage ( )

static

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

generate the content of a csp page.

Reimplemented from Page.

Reimplemented in ShowPlan.

◆ OnPreHTTP()

_.Library.Boolean OnPreHTTP ( )

static

Event handler for PreHTTP event: this is invoked before.

the HTTP headers for a CSP page have been sent. All changes to the <class>CSP.Response</class> class, such as adding cookies, HTTP headers, setting the content type etc. must be made from within the OnPreHTTP() method. Also changes to the state of the CSP application such as changing session.EndSession or session.AppTimeout must be made within the OnPreHTTP() method. It is prefered that changes to session.Preserve are also made in the OnPreHTTP() method as this is more efficient, although it is supported in any section of the page. Return 0 to prevent <method>OnPage</method> from being called.

Reimplemented from Page.

Reimplemented in QueryResultsWindow, and QueryBuilderWindow.

◆ SetNamespace()

_.Library.Status SetNamespace ( _.Library.String ns )

static

This utility method actually changes namespaces.

[Previously private]

Member Data Documentation

◆ AUTOLOGOUT

AUTOLOGOUT = None

static

This class is used internally by InterSystems IRIS.

You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

A specialized CSP page that automatically displays a page based on information provided by a subclass.

If true, this page will automatically logout after a period of time

◆ IFRAMEALLOWED

IFRAMEALLOWED = None

static

Allow pages to have iframes by not setting x-frame-options: same origin.

Set default for Management Portal as iframes are not allowed.

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ ChangeNamespace()

◆ DrawBODY()

◆ DrawShowDoc()

◆ GetCSPClassName()

◆ OnPage()

◆ OnPreHTTP()

◆ SetNamespace()

Member Data Documentation

◆ AUTOLOGOUT

◆ IFRAMEALLOWED