Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / CSPX.SVGEditor
Private  Storage   

CSPX.SVGEditor


class CSPX.SVGEditor extends
%CSP.Page

Base class for SVG-editor documents displayed in Studio

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 7


Summary


Methods
%ClassIsLatestVersion %ClassName %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetParameter %IsA
%New %OriginalNamespace %PackageName %SetModified
ConvertParameter Decrypt DrawHTMLHead DrawInitDocument
DrawInitEditorFunction Encrypt EscapeHTML EscapeURL
GetDocument HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate Link
OnDrawHTMLHead OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page QuoteJS RewriteURL ShowError
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL

Subclasses
CSPX.EnsDTLEditor

Parameters


• parameter DOMAIN = "Ensemble";
Use our own domain for localization
• parameter EDITORURL;
URL used to render editor
• parameter HEIGHT = 2000;
Initial height of editor
• parameter WIDTH = 2000;
Initial width of editor

Methods


• classmethod DrawHTMLHead()
Draw Head section for editor page
• classmethod DrawInitDocument(pDocument As %RegisteredObject) as %Status
Find the document for the given document pDocument and write out its initial state as an xml document.
• classmethod DrawInitEditorFunction(pDocument As %RegisteredObject) as %Status
Give subclass opportunity to inject additional JS code into the client-side initEditor function
• classmethod GetDocument(pName As %String, Output pDocument As %RegisteredObject) as %Status
Find corresponding "document" object for this page.
• classmethod OnDrawHTMLHead()
Draw any additional JS or other head section items
• classmethod OnPage() as %Status
Event handler for PAGE event: this is invoked in order to generate the content of a csp page.
• classmethod OnPreHTTP() as %Boolean
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.