Home > Class Reference > ENSLIB namespace > CSPX.EnsHomePagePane
Private  Storage   


class CSPX.EnsHomePagePane extends %CSP.Util.Pane


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 7 11


Align Buttons CommandFormClass CommandFormObject
CommandSubmitPage Commands Display Dynamic
FormClass FormObject FrameStyle Name
Styles SubmitPage SubmitTarget Text

%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 DrawButton DrawCommandForm DrawCommands
DrawHEAD DrawItems DrawProduction DrawSubject
DrawWarnButton GenerateCode LocalizeText OnGenerateCode
ProductionRecover QuoteCOS ResetCounters ResetProperties
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType


• parameter DOMAIN = "Ensemble";
Use our own domain for localization
• parameter RefreshRate = 23;


• property Buttons as list of %CSP.Util.FormButton(XMLITEMNAME="Button");
An optional list of buttons displayed along the bottom of a form.
• property Display as %String(MAXLEN=20,VALUELIST=",form,table");
How to display this Form Page.
• property Dynamic as %Boolean;
If true, display this form using the Dynamic form viewer.
• property FormClass as %String(MAXLEN=128);
Name of class used to provide Detail or Form view;
• property FormObject as %RegisteredObject(XMLPROJECTION="none");
The object that provides the details to display.
• property SubmitPage as %String(MAXLEN=128);
Page (URL) to go to when a form is submitted.
• property SubmitTarget as %String(MAXLEN=128);
TARGET attribute for submitted form.


• method DrawBODY(pInstance As %CSP.Util.PageInstance) as %Status
Draw the BODY of the detail pane
• method DrawButton(LinkAction As %String, Caption As %String)
Generic method to Draw a EnsButton on the home page
• method DrawHEAD(pInstance As %CSP.Util.PageInstance) as %Status
Overwritten by subclasses to draw anything this pane needs for the HEAD section.
• method DrawItems(Subject)
Generic method to draw subject+item for each line
• method DrawProduction()
Draw Production Info
• method DrawSubject(Subject, HeaderLink)
Generic method to draw subject box
• method DrawWarnButton(LinkAction As %String, Caption As %String, pToolTip As %String = "")
Generic method to Draw a Ens warning button
• method OnGenerateCode() as %String
Subclasses override this to generate code during CSP processing
• classmethod ProductionRecover()
This method is called when user clicks Recover button
• classmethod ResetCounters()
This method is called when user clicks the "Reset" button
• classmethod ResetProperties()
Get summary and update counters. Numbers are set into page directly without refresh page. If Production State value changes, e.g. from Running to Suspended or Troubled, or if Production Update value changes, e.g. from 0 to 1, then the whole page is reloaded.