Home > Class Reference > ENSLIB namespace > CSPX.AbstractSVGDocument

CSPX.AbstractSVGDocument

abstract class CSPX.AbstractSVGDocument extends %Studio.AbstractDocument

Abstract Document used to server SVG-editor documents into Studio
Subclasses need to provide:
RegisterExtension Projection
Save method
Exists method
EDITORURL parameter
DOCUMENTCLASS parameter

Method Inventory

Parameters

parameter DOCUMENTCLASS;
If set, name of superclass used for documents of this type.
For example, Ens.DataTransformDTL
parameter DOMAIN = Ensemble;
Use our own domain for localization
parameter EDITORURL;
URL to use to get actual editor for Studio to display.
parameter EXTENSION;
File extension used for this document (e.g., .dtl)

Methods

method Compile(flags As %String) as %Status [ Language = objectscript ]
Compile this document
classmethod Delete(name As %String) as %Status [ Language = objectscript ]
Delete the class that corresponds to document name. Subclass should override this behavior for non-class based editors.
classmethod Exists(name As %String) as %Boolean [ Language = objectscript ]
Return 1 if the given document exists and 0 if it does not.
Subclass should override this behavior.
classmethod GetClassName(pName As %String) as %String [ Language = objectscript ]
return the corresponding class name for this document
classmethod GetOther(Name As %String) as %String [ Language = objectscript ]
Return other document types that this is related to. Passed a name and you return a comma separated list of the other documents it is related to or "" if it is not related to anything
Subclass should override this behavior for non-class based editors.
classmethod HasExtension(name As %String, ext As %String) as %Boolean [ Language = objectscript ]
Check to see that the file type matches
classmethod ListClose(ByRef qHandle As %Binary) as %Status [ Language = objectscript ]
classmethod ListExecute(ByRef qHandle As %Binary, Directory As %String, Flat As %Boolean, System As %Boolean) as %Status [ Language = objectscript ]
classmethod ListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]
method Load() as %Status [ Language = objectscript ]
Return URL for Studio to use to load editor.
classmethod TimeStamp(name As %String) as %TimeStamp [ Language = objectscript ]
Return the timestamp of routine 'name' in %TimeStamp format. This is used to determine if the routine has been updated on the server and so needs reloading from Studio. So the format should be $zdatetime($horolog,3), or "" if the routine does not exist.
Subclass should override this behavior for non-class based editors.

Queries

query List(Directory As %String, Flat As %Boolean, System As %Boolean)
Selects name As %String, modified As %TimeStamp, size As %Integer, directory As %String
Subclass should override this query for non-class based editors.

Inherited Members

Inherited Properties

Inherited Methods