This is a specialized CSP page that serves SVG content for a ZEN svgFrame. More...

Inheritance diagram for svgPage:

[legend]

Collaboration diagram for svgPage:

[legend]

Public Member Functions
	onSVGLoad ()
	This method is called when this svgPage is loaded.

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

Static Public Member Functions
_.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...

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
	CSSINCLUDES = None
	Additional set of CSS style files to include.

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

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

	USERSVGPACKAGES = None
	Comma-separated list of component packages whose. 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	ApplyURLParms ()
	Copy URL parameters supplied to this page into the. More...

	DrawClassDefinitions ()
	Draw out client-side class definitions for components on this page. More...

	DrawObjectDefinitions ()
	Write out client-side object definitions for components on this page. More...

_.Library.Status	DrawObjectProperties ()
	Draw JavaScript needed to initialize properties for client side of this object.

	DrawSVGPage ()
	Draw standard SVG wrapper.

_.Library.Status	InvokeCallback (_.Library.String pMethod)
	Internal Method. More...

_.Library.Status	OnDrawSVGPage ()
	Callback method. More...

Static Private Member Functions
_.Library.Status	DrawClassDefinition ()
	Draw JavaScript needed to define client-side class for this page (if any).

	DrawSVGDef ()
	Write out SVG defs defined for this component More...

	DrawSVGDefs ()
	This method writes out all SVG Defs defined by ZEN library. More...

	DrawStyleSVG ()
	Write out SVG/CSS style sheet defined for this component More...

_.Library.String	EndScript ()
	Write string used to end client-side script code. More...

_.Library.String	GetSuperClassList (pList)
	Construct a list of component super classes of this class. More...

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

_.Library.Status	OnDrawSVGDef ()
	Callback method called when drawing the SVG defs for this page.

_.Library.Status	OnDrawSVGScript ()
	Callback for adding scripts to this SVG page.

_.Library.Status	OnDrawStyleSVG ()
	Callback method called when drawing the SVG CSS style for this page.

_.Library.String	StartScript ()
	Write string used to introduce client-side script code. More...

Detailed Description

This is a specialized CSP page that serves SVG content for a ZEN svgFrame.

This is an instantiable CSP page.

Member Function Documentation

◆ ApplyURLParms()

_.Library.Status ApplyURLParms ( )

private

Copy URL parameters supplied to this page into the.

appropriate properties of this page.

◆ DrawClassDefinitions()

DrawClassDefinitions ( )

private

Draw out client-side class definitions for components on this page.

Caller is responsible for drawing enclosing script tags.

◆ DrawObjectDefinitions()

DrawObjectDefinitions ( )

private

Write out client-side object definitions for components on this page.

Caller is responsible for drawing enclosing script tags.

◆ DrawSVGDef()

DrawSVGDef ( )

staticprivate

Write out SVG defs defined for this component

This is based on the XData block, SVGDef.

◆ DrawSVGDefs()

DrawSVGDefs ( )

staticprivate

This method writes out all SVG Defs defined by ZEN library.

components.

◆ DrawStyleSVG()

DrawStyleSVG ( )

staticprivate

Write out SVG/CSS style sheet defined for this component

This is based on the XData block, SVGStyle.

◆ EndScript()

_.Library.String EndScript ( )

staticprivate

Write string used to end client-side script code.

[Previously private]

◆ GetSuperClassList()

_.Library.String GetSuperClassList ( pList )

staticprivate

Construct a list of component super classes of this class.

as csv list (include this class as well).
This is used at page render-time to build the list of classes needed by the client page.

◆ InvokeCallback()

_.Library.Status InvokeCallback ( _.Library.String pMethod )

private

Internal Method.

This is used to invoke callback methods and trap for errors.

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

◆ OnDrawSVGPage()

_.Library.Status OnDrawSVGPage ( )

private

Callback method.

If defined, this provides a way for a subclass to add static SVG content to the svgPage.

◆ StartScript()

_.Library.String StartScript ( )

staticprivate

Write string used to introduce client-side script code.

[Previously private]

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

◆ 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

◆ JSINCLUDES

JSINCLUDES = None

static

Comma-separated list of additional JS include files.

These are included within the inner SVG page served by this class only.

◆ RESOURCE

RESOURCE = None

static

This is a comma-delimited list of system Resources and associated.

permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

◆ USERSVGPACKAGES

USERSVGPACKAGES = None

static

Comma-separated list of component packages whose.

style definitions are in pre-generated include files. This is merged with the list provided by the parent page.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ ApplyURLParms()

◆ DrawClassDefinitions()

◆ DrawObjectDefinitions()

◆ DrawSVGDef()

◆ DrawSVGDefs()

◆ DrawStyleSVG()

◆ EndScript()

◆ GetSuperClassList()

◆ InvokeCallback()

◆ LinkCSS()

◆ LinkScript()

◆ OnDrawSVGPage()

◆ StartScript()

◆ OnPage()

◆ OnPreHTTP()

Member Data Documentation

◆ JSINCLUDES

◆ RESOURCE

◆ USERSVGPACKAGES