Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%CSP] >  [Util] >  [Pane]
Private  Storage   

class %CSP.Util.Pane extends %RegisteredObject, %XML.Adaptor

This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Describes a particular pane within an AutoPage. This is an abstract class; its subclasses perform the real work.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 10 8


Summary

Properties
Align CommandFormClass CommandFormObject CommandSubmitPage
Commands FrameStyle Name Styles
Text URL

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
DrawBODY DrawCommandForm DrawCommands DrawHEAD
GenerateCode LocalizeText OnGenerateCode QuoteCOS
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType

Subclasses
%CSP.UI.SQL.QueryBuilderPane %CSP.UI.SQL.SQLPane %CSP.UI.SQL.ShowPlanPane
%CSP.UI.SQL.ViewPane %CSP.UI.System.OpenJournalPane %CSP.UI.System.SecurityAdvisorPane
%CSP.UI.System.UserProfilePane %CSP.UI.System.ViewTextFilePane %CSP.Util.ExpPane
%CSP.Util.FormPane %CSP.Util.HTMLDashboardPane %CSP.Util.MenuPane
%CSP.Util.NavigatorPane %CSP.Util.SMNavigatorPane %CSP.Util.SMTitlePane
%CSP.Util.TablePane %CSP.Util.TitlePane CSPX.EnsBPLInfoPane
CSPX.EnsBPLPane CSPX.EnsConfig CSPX.EnsDTLPane
CSPX.EnsDashboardInfoPane CSPX.EnsDashboardPane CSPX.EnsDebugSettingsPane
CSPX.EnsGraphPane CSPX.EnsHomePagePane CSPX.EnsHostWizardPane
CSPX.EnsMsgPane CSPX.EnsMsgTracePane CSPX.EnsProductionDeletePane
CSPX.EnsProductionWizardPane CSPX.EnsPurgePane CSPX.Enterprise.Portal.MsgPane
CSPX.Enterprise.Portal.MsgTracePane Ens.Util.Documatic EnsLib.Workflow.UI.ItemDetailPane
EnsLib.Workflow.UI.RoleMembersDetailPane

Parameters

• parameter DOMAIN = "%Utility";
Default Localization Domain
• parameter XMLNAME = "Pane";
This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties

• property Align as %String(MAXLEN=10,VALUELIST=",left,right,center");
Suggestion for how to align this pane; Actual implementation is up to the subclass doing the rendering
• property CommandFormClass as %String(MAXLEN=128);
Name of class used to provide an option CommandForm: a form containing command buttons.
Note: there is no support for dynamic command forms.
• property CommandFormObject as %RegisteredObject(XMLPROJECTION="none");
Used to hold the object instance for the command form.
• property CommandSubmitPage as %String(MAXLEN=128);
Page (URL) to go to when the command form is submitted.
• property Commands as list of Action;
A list of commands; these are actions that are typically displayed along the top of the pane.
• property FrameStyle as %String(MAXLEN=50,XMLNAME="FrameStyle");
Optional Style Sheet for a pane; Set to "none" to supress style-sheet for a fram
• property Name as %String(MAXLEN=100,XMLPROJECTION="none");
Transient: name of the pane/frame this pane is being used for
• property Styles as array of %String(XMLKEYNAME="name",XMLNAME="PaneStyle",XMLPROJECTION="ELEMENT");
Arbitrary array of styles (name/value pairs). All panes include this property.
• property Text as %String(MAXLEN=500);
Test for this pane. All panes include this property.
• property URL as %String(MAXLEN=256,XMLNAME="url",XMLPROJECTION="element");
Optional URL to display instead of this pane (for frame-pages)

Methods

• method DrawBODY(pInstance As PageInstance) as %Status
Overwritten by subclasses to draw anything this pane needs for the BODY section.
• method DrawCommandForm(pInstance As PageInstance) as %Status
Generic method to draw a command form for a pane
• method DrawCommands(pInstance As PageInstance) as %Status
Generic method to draw commands for a pane; A subclass can override this.
• method DrawHEAD(pInstance As PageInstance) as %Status
Overwritten by subclasses to draw anything this pane needs for the HEAD section.
• method GenerateCode() as %String
Called by CSP rules engine to generate code to construct an instance of this object using the current instance as a template.
• classmethod LocalizeText(pText As %String, pDomain As %String = "%Utility") as %String
Return the localized version of the string pText. A localizable string starts with "@[domainname:]textid@....." If domainname exists then use it ; Else if pDomain passed in then use it ; Else default to %Utility. Also, substitute any run-time expressions of the form {$ID1} with Page variables...
• method OnGenerateCode() as %String
Subclasses override this to generate code during CSP processing
• classmethod QuoteCOS(pText As %String) as %String
Return a quoted, COS version of a string.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.