%ZEN.StudioDocument.AbstractDocument
abstract stream class %ZEN.StudioDocument.AbstractDocument extends %Studio.AbstractDocument
Abstract Document used to serve ZEN-editor documents into StudioIn order to create a new Studio Abstract Document, you need to create a subclass of this class and provide the following:
- A class Projection named RegisterExtension.
For example:
Projection RegisterExtension As %Projection.StudioDocument(DocumentExtension = "BPL"); - A value for the EDITORURL parameter.
This is the URL of the page that provides the actual editor UI. - If needed, a value for the DOCUMENTCLASS parameter.
- An override of the Save() method.
- An override of the Exists() method.
Method Inventory (Including Private)
- Compile()
- Delete()
- Exists()
- GetClassName()
- GetOther()
- ListClose()
- ListExecute()
- ListFetch()
- Load()
- LocalizeDescription()
- TimeStamp()
Parameters
parameter DESCRIPTION;
Description Studio will display for this document.
If DOMAIN is defined this will be localized.
If DOMAIN is defined this will be localized.
parameter DOCUMENTCLASS;
If set, name of superclass used for documents of this type.
For example, "Ens.DataTransformDTL"
For example, "Ens.DataTransformDTL"
parameter EDITORURL;
URL of the editor Studio will display within its HTML pane.
parameter EXTENSION;
File extension used for this document (e.g., ".dtl")
parameter LISTABSTRACT = 0;
If true, the built-in document list logic will include abstract classes
otherwise they are ignored.
Methods (Including Private)
Compile this document
Delete the class that corresponds to document name.
Subclass should override this behavior for non-class based editors.
Return 1 if the given document exists and 0 if it does not.
Subclass can override this behavior.
Subclass can override this behavior.
Return the corresponding class name for this document
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.
Subclass should override this behavior for non-class based editors.
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 LocalizeDescription(ext As %String, ByRef Description As %String(MAXLEN=500)) as %Status [ Language = objectscript ]
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.
Subclass should override this behavior for non-class based editors.
Queries
Subclass should override this query for non-class based editors.
Inherited Members
Inherited Properties (Including Private)
- %Concurrency
- %Location
- AtEnd
- Attributes
- Code
- CompileTime
- Generated
- Id
- LastModified
- LineTerminator
- Locked
- Mode
- Name
- Size
- TimeStamp
- UpToDate
Inherited Methods (Including Private)
- %AcquireLock()
- %AddToSaveSet()
- %CheckUnique()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %ConstructCloneInit()
- %Delete()
- %DeleteData()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GetLockReference()
- %GetParameter()
- %GetSerial()
- %GetSwizzleObject()
- %Id()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %LOBPrefetch()
- %LOBPrefetchInternal()
- %Load()
- %LoadData()
- %LocationSet()
- %LockStream()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %ObjectSize()
- %ObjectSizeInternal()
- %Oid()
- %OnAddToSaveSet()
- %OnAfterSave()
- %OnBeforeSave()
- %OnClose()
- %OnConstructClone()
- %OnDelete()
- %OnNew()
- %OnOpen()
- %OnReload()
- %OnRollBack()
- %OnValidateObject()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %ReleaseLock()
- %Reload()
- %RemoveFromSaveSet()
- %RollBack()
- %Save()
- %SaveData()
- %SerializeObject()
- %SetModified()
- %SetSerial()
- %UnlockStream()
- %ValidateObject()
- AtEndGet()
- AtEndSet()
- Clear()
- CompileDocument()
- CompileTime()
- CompileTimeGet()
- CopyFrom()
- CopyFromAndSave()
- DeleteAttribute()
- DeleteStream()
- ExportToXML()
- FindAt()
- Flush()
- GetAttribute()
- GetAttributeList()
- GetPrevious()
- GetStreamId()
- IODeleteStream()
- IOFlush()
- IOGetSize()
- IOGetStreamId()
- IOInit()
- IOMoveToEnd()
- IOOnClose()
- IOOnNew()
- IOOpenStream()
- IOReadData()
- IORewind()
- IOSaveStream()
- IOWriteData()
- ImportFromXML()
- InputFromDevice()
- IsCharacter()
- IsDefinedAttribute()
- IsEnabled()
- IsGenerated()
- IsMapped()
- IsNull()
- IsUpToDate()
- ItemList()
- LastModifiedGet()
- LineTerminatorSet()
- Lock()
- LockName()
- MoveTo()
- MoveToEnd()
- NextAttribute()
- OpenStream()
- OutputToDevice()
- OutputToDeviceAt()
- Read()
- ReadLine()
- ReadLineIntoStream()
- ReadSQL()
- Rewind()
- Save()
- SaveAs()
- SaveStream()
- Search()
- SearchRegex()
- SerializeToSyncSet()
- SetAttribute()
- SetAttributeList()
- SizeGet()
- StreamOIDIsNull()
- SyncStreamIn()
- TimeStampGet()
- TranslateExportName()
- Unlock()
- UnlockName()
- UpToDateGet()
- Write()
- WriteLine()
- checkMatch()
- escapeCData()
- escapeCDataStream()
- unescapeCData()