Base Zen application class for portal pages implemented using Zen. More...

Inheritance diagram for Application:

[legend]

Collaboration diagram for Application:

[legend]

Static Public Member Functions
_.Library.Boolean	CanShowSwitch (PageName)
	Determine if the "Switch" link for namespace can be shown. More...

	DrawUsername ()
	Draw username with (or without) link to change password. More...

_.Library.Status	GetContextLinks (pLinks)
	Define any context links for the context menu in the header. More...

_.Library.Status	GetQuickLinks (pLinks)
	Provide any quick links for pages.

Static Public Member Functions inherited from application
_.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
	This is the name of this application.

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

Static Public Attributes inherited from application
	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...

Static Private Member Functions
	DrawLocatorMenu (_.Library.String pLocatorMenu)
	Draw bread-crumb links.

	DrawSmallMenu (_.Library.String pMenu, _.Library.String pLocatorMenu)
	Draw small menu at the top of the title area.

_.Library.Status	DrawTitleHTML (_.Library.String pProduct, _.Library.String pTitle, pSmallMenu, pLocatorMenu, pContextMenu)
	Draw the HTML contents of the title area for portal pages. More...

_.Library.Status	DrawTitleServerHTML (_.Library.String pProduct, _.Library.String pTitle, pSmallMenu, pLocatorMenu)
	This method draws the server/namespace/user/license/instance information inside the title pane. More...

_.Library.String	OnGetProductName ()
	Get the product name for the page. 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

Base Zen application class for portal pages implemented using Zen.

Member Function Documentation

◆ DrawTitleHTML()

_.Library.Status DrawTitleHTML	(	_.Library.String	pProduct,
		_.Library.String	pTitle,
			pSmallMenu,
			pLocatorMenu,
			pContextMenu
	)

staticprivate

Draw the HTML contents of the title area for portal pages.

pProduct may contain specific product logo if passed in as the second piece. pContextMenu is passed in for CSP pages only!

◆ DrawTitleServerHTML()

_.Library.Status DrawTitleServerHTML	(	_.Library.String	pProduct,
		_.Library.String	pTitle,
			pSmallMenu,
			pLocatorMenu
	)

staticprivate

This method draws the server/namespace/user/license/instance information inside the title pane.

pProduct may contain specific server name if passed in as the third piece (for HS debug purposes).

◆ OnGetProductName()

_.Library.String OnGetProductName ( )

staticprivate

Get the product name for the page.

May be called from none-Zen classes in SMP.

◆ CanShowSwitch()

_.Library.Boolean CanShowSwitch ( PageName )

static

Determine if the "Switch" link for namespace can be shown.

Return 1 if yes, and 0 if not.

◆ DrawUsername()

DrawUsername ( )

static

Draw username with (or without) link to change password.

The link is built only for the Home page.

◆ GetContextLinks()

_.Library.Status GetContextLinks ( pLinks )

static

Define any context links for the context menu in the header.

piece 1: caption (if left null, a menu seperator will be built) piece 2: URL (this is required entry) piece 3: JS function name (if defined is a javascript to call such as "zenPage.save()") Note that all security processing is performed in the page's CheckContextLinks() method.

Static Public Member Functions

Static Public Attributes

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DrawTitleHTML()

◆ DrawTitleServerHTML()

◆ OnGetProductName()

◆ CanShowSwitch()

◆ DrawUsername()

◆ GetContextLinks()