Home > Class Reference > ENSLIB namespace > EnsPortal.Dialog.standardDialog
Private  

EnsPortal.Dialog.standardDialog

abstract class EnsPortal.Dialog.standardDialog extends %CSP.Portal.standardDialog, EnsPortal.Template.base

Base class for Ensemble dialog pages.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 7 10

Summary

This is a Zen Page class. It belongs to the application EnsPortal.Application.

Properties
%condition %import %includeFiles %page
%resource FirstFailed InvalidParam IsEMSReadOnly
ValidationErrorMsg align aux backgroundTimerInterval
canEdit cellAlign cellSize cellStyle
cellVAlign children closeOnEnter closeOnEsc
composite containerStyle cssLevel dialogTitle
disabled disabledStyle dragAndDrop dragEnabled
dropEnabled enclosingClass enclosingStyle error
groupClass groupStyle hasButtons height
hidden hideApplyButton hideCancelButton hideOKButton
hint hintClass hintStyle id
index keepAliveInterval label labelClass
labelDisabledClass labelPosition labelStyle layout
msgNotPermitted name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate parent
showLabel slice studioMode title
tuple useSVG useSoftModals valign
visible width window zenPersistentPopup
Methods
%AddCSPShareHyperevents %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddEnsExceptionHandler %AddImportedComponents %AddToSaveSet
%ApplyURLParms %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawAutoLogout %DrawClassDefinitions %DrawComponentHTML
%DrawHTML %DrawHTMLPage %DrawJSStrings %DrawObjectDefinitions
%DrawTitle %EnclosingDivId %EndBackgroundMethod %EndScript
%Eval %EvalC %Extends %ForceClientRender
%GetChildIndex %GetComponent %GetComponentById %GetComponentByName
%GetEventHandlers %GetLinks %GetPageName %GetParameter
%GetValueById %GetValueByName %GetXMLName %IsA
%IsModified %Link %LinkCSS %LinkScript
%MakeId %New %NormalizeObject %ObjectModified
%OnAddToPageAfter %OnAddToPageBefore %OnAfterCreatePage %OnBeforeCreatePage
%OnCreateApplication %OnCreatePage %OnDetermineCSSLevel %OnDrawEnclosingDiv
%OnDrawHTMLBody %OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties
%OnFinishBackgroundTask %OnGetSubtitle %OnGetTitle %OnMonitorBackgroundTask
%OnMutateChildren %OnObjectSynch %OnPreHTTP %OnSubmit
%OnUseSoftModals %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %RemoveChild %RemoveChildren
%RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod %Self
%SerializeObject %SetBackgroundMethodStatus %SetErrorById %SetErrorByName
%SetModified %SetValueById %SetValueByName %SetValuesByName
%StartScript %ValidateObject %ZENVersion ConvertParameter
Decrypt Encrypt EscapeHTML EscapeURL
EvalResult GetHyperEventResources HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
Link OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page QuoteJS RewriteURL ShowError
SimpleKeepAlive StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore addPopupSuffix adjustSize btnApply
btnOK cancelPopup checkEdit childrenMutated
clientKeepAlive correctIELayering createComponent createComponentNS
ctrlKeyDown deleteComponent dialogApply dialogCancel
dialogFinish dialogTitleGet disableButtons dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dropHandler
dropStartHandler endModal exposeComponent findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getComponent getComponentById getDialogValue
getEnclosingDiv getHidden getHintElement getLabelElement
getOpener getProperty getSettings getType
gotoPage inResizeLoop initPopupSuffix invokeSuper
isOfType launchPopupWindow makeId onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondialogCancel ondialogFinish
ondialogStart ondisabledHandler onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler onoverlayHandler
onresizeHandler onunloadHandler onupdateHandler popupActionHandler
refreshContents removeChild removePopupSuffix render
renderContents renderSVG resetMsg setComponentId
setHidden setOverlayMode setProperty setPropertyAll
setTraceOption showMsg startKeepAlive startModal
startProgressBar stopKeepAlive stopProgressBar validateRequired
Subclasses
EnsPortal.ConfigItemSelector EnsPortal.ConstraintEditor EnsPortal.DateTimeEditor
EnsPortal.Dialog.BrowserExportSelect EnsPortal.Dialog.BusinessPartnerDetails EnsPortal.Dialog.BusinessProcessAction
EnsPortal.Dialog.BusinessProcessContext EnsPortal.Dialog.BusinessProcessSave EnsPortal.Dialog.BusinessProcessValueEditor
EnsPortal.Dialog.BusinessProcessWizard EnsPortal.Dialog.BusinessProcessXSLTParm EnsPortal.Dialog.BusinessRuleSave
EnsPortal.Dialog.BusinessRuleWizard EnsPortal.Dialog.ChangeClass EnsPortal.Dialog.ClassCompile
EnsPortal.Dialog.ComplexMapDelete EnsPortal.Dialog.ComplexMapGenerate EnsPortal.Dialog.Confirmation
EnsPortal.Dialog.DTLFunctionWizard EnsPortal.Dialog.DataTransformSave EnsPortal.Dialog.DataTransformWizard
EnsPortal.Dialog.DeploymentDetails EnsPortal.Dialog.EventTextPopup EnsPortal.Dialog.ExportFromItem
EnsPortal.Dialog.ExportMessages EnsPortal.Dialog.GenerateJGInitiator EnsPortal.Dialog.GenerateJGProduction
EnsPortal.Dialog.Import EnsPortal.Dialog.ImportJBH EnsPortal.Dialog.LookupSaveAs
EnsPortal.Dialog.LookupSelect EnsPortal.Dialog.MessageBodyDisplay EnsPortal.Dialog.ObjectEntry
EnsPortal.Dialog.ProductionAddHost EnsPortal.Dialog.ProductionAddItemSettings EnsPortal.Dialog.ProductionConfigurationLegend
EnsPortal.Dialog.ProductionItemSettings EnsPortal.Dialog.ProductionWizard EnsPortal.Dialog.RecordMapDelete
EnsPortal.Dialog.RecordMapSave EnsPortal.Dialog.RecordMapSimpleBatch EnsPortal.Dialog.SFTPTest
EnsPortal.Dialog.ScheduleImport EnsPortal.Dialog.ScheduleSelect EnsPortal.Dialog.ScheduleView
EnsPortal.Dialog.SearchCriteria EnsPortal.Dialog.SourceControlOutput EnsPortal.Dialog.TestTransform
EnsPortal.Dialog.TestingService EnsPortal.Dialog.TooltipPopup EnsPortal.Dialog.TransformSelector
EnsPortal.Dialog.UpdateProduction EnsPortal.Dialog.WorkflowRoleAddUser EnsPortal.Dialog.WorkflowRoleRemoveUser
EnsPortal.Dialog.WorkflowRoleTasks EnsPortal.Dialog.WorkflowRoleUsers EnsPortal.Dialog.WorkflowTaskAssign
EnsPortal.Dialog.WorkflowUserRoles EnsPortal.Dialog.WorkflowUserTasks EnsPortal.Dialog.fileSelect
EnsPortal.ExpressionEditor EnsPortal.VisualTrace EnsPortal.VisualTraceLegend

Parameters

parameter APPLICATION = "EnsPortal.Application";
Enable styles that are common to all pages and dialogs for the EnsPortal application.
parameter APPLYBUTTON = 1;
If true, then this dialog displays an Apply button.
parameter CLOSEONENTER = 0;
Allow popup to close as if clicking button "OK" when user presses the ENTER key. Usually this parameter would be set to 1 if the dialog does not contain input fields.
parameter CLOSEONESC = 1;
Allow popup to close as if clicking button "Cancel" or "X" when user presses the ESC key.
If this parameter has value 0, the popup will not close when user presses ESC.
If this parameter has value 1, the popup will be dismissed (canceled) when user presses ESC.
If this parameter has value 2, and the popup has button "OK", the popup will close as if clicking "OK".
parameter DOMAIN = "Ensemble";
Localization domain
parameter EDITRESOURCE;
Resource for subclasses to indicate whether further resources are needed to perform actions on pages.
parameter OKBUTTON = 1;

Properties

property canEdit as %ZEN.Datatype.boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList(..#EDITRESOURCE) ];
Flag to indicate whether the user is permitted to make any changes on a given page.
property closeOnEnter as %ZEN.Datatype.boolean [ Final,InitialExpression = +..#CLOSEONENTER ];
property closeOnEsc as %ZEN.Datatype.integer [ Final,InitialExpression = +..#CLOSEONESC ];
Allow the window to be closed by pressing ESC instead of clicking the Cancel button or the "X" icon.
property hasButtons as %ZEN.Datatype.boolean [ Final,InitialExpression = ..#APPLYBUTTON || ..#OKBUTTON || ..#CANCELBUTTON ];
This is used to indicate whether this dialog has any buttons at all.
property hideOKButton as %ZEN.Datatype.boolean [ Final,InitialExpression = '+..#OKBUTTON ];
This is used to indicate whether this dialog has an OK button.
property msgNotPermitted as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("You are not permitted to perform this action") ];
Message to inform the user they may not perform a given action.
property studioMode as %ZEN.Datatype.boolean(ZENURL="STUDIO") [ InitialExpression = 0 ];
Flag to indicate that the dialog is running in Studio.

Methods

method %OnAfterCreatePage() as %Status
Avoid writing out the session cookie if we are in a Studio session.
classmethod %OnCreateApplication(Output pStatus As %Status, pApplicationName As %String) as %ZEN.application
Ensure that the user has USE permissions on %Ens_Portal before creating the application object
method %OnDetermineCSSLevel() as %Integer
Force HTML5 mode when the client has a version of Internet Explorer that supports HTML5.
method %OnDrawHTMLHead() as %Status
Add the EnsException error handling on the client.
method %OnDrawHTMLMeta() as %Status
Ensure that we force Internet Explorer to use its most recent rendering engine.
classmethod GetHyperEventResources(pMethod As %String = "") as %String
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
classmethod OnPreHyperEvent(class As %String, method As %String) as %Status
Invoke the base OnPreHyperEvent() method, and then check whether the user is permitted to invoke the specified method by checking the resource returned by the GetHyperEventResources callback. Also avoid sending back the session cookie if we are invoked in a Studio session.
method checkEdit() [ Language = javascript ]
method onkeydownHandler() [ Language = javascript ]
Handle keypress of ESC and ENTER.
method onloadHandler() [ Language = javascript ]
Trigger keepAlive behaviour for the page.