Home > Class Reference > %SYS namespace > %ZEN.SVGComponent.svgPage

%ZEN.SVGComponent.svgPage

class %ZEN.SVGComponent.svgPage extends %Library.RegisteredObject, %CSP.Page

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

Method Inventory (Including Private)

Parameters

parameter CONTENTTYPE = image/svg+xml;
Inherited description: Specifies the default content type for the page. This can be overriden using the <CSP:CONTENT TYPE=> tag, or by setting the %response.ContentType property in the OnPreHTTP() method. The default value if this parameter is not set is text/html.
parameter CSSINCLUDES;
Additional set of CSS style files to include.
parameter JSINCLUDES;
Comma-separated list of additional JS include files. These are included within the inner SVG page served by this class only.
parameter RESOURCE;
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.
parameter USERSVGPACKAGES;
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.

Methods (Including Private)

final method %ApplyURLParms() as %Status [ Language = objectscript ]
Copy URL parameters supplied to this page into the appropriate properties of this page.
final classmethod %DrawClassDefinition() as %Status [ Language = objectscript ]
Draw JavaScript needed to define client-side class for this page (if any).
final method %DrawClassDefinitions() [ Language = objectscript ]
Draw out client-side class definitions for components on this page. Caller is responsible for drawing enclosing script tags.
final method %DrawObjectDefinitions() [ Language = objectscript ]
Write out client-side object definitions for components on this page.
Caller is responsible for drawing enclosing script tags.
final method %DrawObjectProperties() as %Status [ Language = objectscript ]
Draw JavaScript needed to initialize properties for client side of this object
classmethod %DrawSVGDef() [ Language = objectscript ]
Write out SVG defs defined for this component
This is based on the XData block, SVGDef.
classmethod %DrawSVGDefs() [ Language = objectscript ]
This method writes out all SVG Defs defined by ZEN library components.
final method %DrawSVGPage() [ Language = objectscript ]
Draw standard SVG wrapper
classmethod %DrawStyleSVG() [ Language = objectscript ]
Write out SVG/CSS style sheet defined for this component
This is based on the XData block, SVGStyle.
classmethod %EndScript() as %String [ Language = objectscript ]
Write string used to end client-side script code [Previously private]
final classmethod %GetSuperClassList(ByRef pList) as %String [ Language = objectscript ]
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.
method %InvokeCallback(pMethod As %String) as %Status [ Language = objectscript ]
Internal Method.
This is used to invoke callback methods and trap for errors.
classmethod %LinkCSS(pFile As %String) as %String [ Language = objectscript ]
Return string used to include a CSS file [Previously private]
classmethod %LinkScript(pFile As %String) as %String [ Language = objectscript ]
Return string used to include a script file [Previously private]
abstract classmethod %OnDrawSVGDef() as %Status [ Language = objectscript ]
Callback method called when drawing the SVG defs for this page.
method %OnDrawSVGPage() as %Status [ Language = objectscript ]
Callback method. If defined, this provides a way for a subclass to add static SVG content to the svgPage.
classmethod %OnDrawSVGScript() as %Status [ Language = objectscript ]
Callback for adding scripts to this SVG page.
abstract classmethod %OnDrawStyleSVG() as %Status [ Language = objectscript ]
Callback method called when drawing the SVG CSS style for this page.
classmethod %StartScript() as %String [ Language = objectscript ]
Write string used to introduce client-side script code [Previously private]
classmethod OnPage() as %Status [ Language = objectscript ]
Inherited description: Event handler for PAGE event: this is invoked in order to generate the content of a csp page.
classmethod OnPreHTTP() as %Boolean [ Language = objectscript ]
Inherited description: Event handler for PreHTTP event: this is invoked before the HTTP headers for a CSP page have been sent. All changes to the %CSP.Response 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 OnPage() from being called.
clientmethod onSVGLoad() [ Language = javascript ]
This method is called when this svgPage is loaded.

Inherited Members

Inherited Methods (Including Private)