This class is used to define a ZEN application. More...

Inheritance diagram for application:

[legend]

Collaboration diagram for application:

[legend]

Static Public Member Functions
_.Library.Status	OnPage ()
	Default OnPage handler– only called if no HOMEPAGE. More...

_.Library.Boolean	OnPreHTTP ()
	Event handler for PreHTTP event: this is invoked before. 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
	APPLICATIONNAME = None
	Optional name of this application. More...

	CSS3INCLUDES = None
	Comma-separated list of additional CSS3 include files that should be. More...

	CSSINCLUDES = None
	Comma-separated list of additional CSS include files that should be. More...

	HOMEPAGE = None
	This is the URL of the main starting page of this application.

	JSINCLUDES = None
	Comma-separated list of additional JS include files that should be. More...

	USERPACKAGES = None
	Comma-separated list of User class packages whose HTML class. More...

	USERSVGPACKAGES = None
	Comma-separated list of User class packages whose SVG class. More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

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

Private Member Functions
_.Library.Status	OnGetJSResources (_.Library.String pResources)
	Applications can implement this callback method in order to define a set of. More...

Static Private Member Functions
	DrawStyleHTML (_.Library.Boolean pSuper, _.Library.Integer pCSSLevel)
	Write out HTML/CSS style sheet defined for this application. More...

	GetApplicationName ()
	Return the display name of this application class.

	GetUserPackages (_.Library.String pUserPackages, _.Library.String pUserSVGPackages)
	Return the USERPACKAGE and USERSVGPACKAGE lists defined for this application class.

_.Library.String	LinkCSS (_.Library.String pFile)
	Return string used to include a CSS file. More...

_.Library.String	LinkScript (_.Library.String pFile)
	Return string used to include a script file. More...

Additional Inherited Members
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Detailed Description

This class is used to define a ZEN application.

This is an instantiable CSP page.

Member Function Documentation

◆ DrawStyleHTML()

DrawStyleHTML	(	_.Library.Boolean	pSuper,
		_.Library.Integer	pCSSLevel
	)

staticprivate

Write out HTML/CSS style sheet defined for this application.

This is based on the XData block, Style.
This style sheet is used to provide application-wide overrides for styles.

◆ LinkCSS()

_.Library.String LinkCSS ( _.Library.String pFile )

staticprivate

Return string used to include a CSS file.

[Previously private]

◆ LinkScript()

_.Library.String LinkScript ( _.Library.String pFile )

staticprivate

Return string used to include a script file.

[Previously private]

◆ OnGetJSResources()

_.Library.Status OnGetJSResources ( _.Library.String pResources )

private

Applications can implement this callback method in order to define a set of.

client-side resources: javascript strings that have been localized.
This is the same as the Zen page callback method except that it is shared by all pages within an application.
This method should fill in the array pResources with a set of localized strings, indexed by resource id:

Set pResources("MyId") = $$$Text("Some string")

Javascript methods can refer to these resources using the helper function zenGetResource:

alert(zenText('MyId'));

Zen defines a set of built-in resource strings using this mechanism. These have a "zen" prefix to keep them seperate from user ids.
Be sure to define the <parameter>DOMAIN</parameter> for your application class if you override this method.

◆ OnPage()

_.Library.Status OnPage ( )

static

Default OnPage handler– only called if no HOMEPAGE.

is defined for this application.

Reimplemented from Page.

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

Member Data Documentation

◆ APPLICATIONNAME

APPLICATIONNAME = None

static

Optional name of this application.

If not defined, the class name of the application is used. This is used for display purposes within some utilities but it not used at run-time.

◆ CSS3INCLUDES

CSS3INCLUDES = None

static

Comma-separated list of additional CSS3 include files that should be.

included for every page within the application.
This is used when the page uses CSS3. The CSS files will be included after any component style sheets and before styles defined by this application class or the page class.

◆ CSSINCLUDES

CSSINCLUDES = None

static

Comma-separated list of additional CSS include files that should be.

included for every page within the application.
The CSS files will be included after any component style sheets and before styles defined by this application class or the page class.

◆ JSINCLUDES

JSINCLUDES = None

static

Comma-separated list of additional JS include files that should be.

included for every page within the application.

◆ USERPACKAGES

USERPACKAGES = None

static

Comma-separated list of User class packages whose HTML class.

and style definitions are in pre-generated include files. These include files will be used by every page within the application.

◆ USERSVGPACKAGES

USERSVGPACKAGES = None

static

Comma-separated list of User class packages whose SVG class.

and style definitions are in pre-generated include files. These include files will be used by every applicable page within the application.

Static Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DrawStyleHTML()

◆ LinkCSS()

◆ LinkScript()

◆ OnGetJSResources()

◆ OnPage()

◆ OnPreHTTP()

Member Data Documentation

◆ APPLICATIONNAME

◆ CSS3INCLUDES

◆ CSSINCLUDES

◆ JSINCLUDES

◆ USERPACKAGES

◆ USERSVGPACKAGES