Class EnsPortal.Dialog.PEXRegistration

hidden class EnsPortal.Dialog.PEXRegistration extends EnsPortal.Dialog.standardDialog

For InterSystems internal use only, subject to change without notice

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
3	9	29

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	Class	FirstFailed	InvalidParam
IsEMSReadOnly	LinkHelp	New	ValidationErrorMsg
align	aux	backgroundTimerInterval	canEdit
canViewFileSystem	cellAlign	cellSize	cellStyle
cellVAlign	children	classpaths	closeOnEnter
closeOnEsc	composite	containerStyle	cssLevel
currFile	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	retValue	showLabel
slice	studioMode	title	tuple
useSVG	useSoftModals	userModifiedProxyName	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	%OnGetPageName	%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	DrawCLASSPATHTable	Encrypt
EscapeHTML	EscapeURL	EvalResult	GetClassClasspaths
GetClassDefaultLanguageServer	GetClassRemoteClass	GetDefaultDir	GetFullFilepath
GetHyperEventResources	HyperEventCall	HyperEventHead	Include
InsertHiddenField	InsertHiddenFields	IsPrivate	JavaInstalled
Link	OnHTTPHeader	OnPage	OnPageError
OnPostHTTP	OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent
Page	QuoteJS	RewriteURL	SetDefaultDir
ShowError	SimpleKeepAlive	StartTimer	StopTimer
SuggestBounce	SwitchCasingToExistingPackage	ThrowError	UnescapeHTML
UnescapeURL	UseIRISHost	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew	XMLSchema
XMLSchemaNamespace	XMLSchemaType	addChild	addChildAfter
addChildBefore	addFile	addPopupSuffix	adjustSize
browseSelect	btnApply	btnOK	cancelPopup
checkEdit	childrenMutated	clientKeepAlive	correctIELayering
createComponent	createComponentNS	createProxyName	ctrlKeyDown
deleteComponent	deleteFile	dialogApply	dialogCancel
dialogFinish	dialogTitleGet	disableButtons	doBounceOnRegister
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
onFileSelect	onPopupAction	onRefreshContents	onSerialize
onServerMethodCall	onServerMethodError	onServerMethodReturn	onStartModalHandler
ondialogCancel	ondialogFinish	ondialogStart	ondisabledHandler
onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler	onlayoutHandler
onloadHandler	onlogoutHandler	onoverlayHandler	onresizeHandler
onunloadHandler	onupdateHandler	popupActionHandler	refreshClasspaths
refreshContents	removeChild	removePopupSuffix	render
renderContents	renderSVG	resetMsg	saveFile
setComponentId	setCurrFile	setHidden	setOverlayMode
setProperty	setPropertyAll	setTraceOption	showMsg
startKeepAlive	startModal	startProgressBar	stopKeepAlive
stopProgressBar	switchCurrFile	userClickedRegister	validateRequired

Parameters

• parameter APPLYBUTTON = 0;

If true, then this dialog displays an Apply button.

• parameter PAGENAME = "Register Component";

Optional. This is the display name used for this page. If not provided, the class name is used.

• parameter PRIVATE = 1;

Controls the access to the page, it can be set to one of the following:

PRIVATE=0 - Page can be linked to/bookmarked

PRIVATE=1 - Can only be referenced from another CSP page

The user needs initially to enter the site through a PUBLIC page.

Properties

• property Class as %ZEN.Datatype.string(ZENURL="CLASS");

• property LinkHelp as %String [ Calculated ];

• property New as %ZEN.Datatype.boolean(ZENURL="NEW");

• property canViewFileSystem as %Boolean [ Final,InitialExpression = $system.Security.Check("%Ens_ViewFileSystem","USE") ];

Is the user permitted to access the fileSelect popup.

• property classpaths as %String(MAXLEN="");

• property currFile as %Integer [ InitialExpression = 0 ];

• 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 retValue as %ZEN.Datatype.string;

Holder for return value.

• property userModifiedProxyName as %Boolean [ InitialExpression = 0 ];

Methods

• method %OnGetPageName() as %String

Get the (localized) name of the page.

• method %OnGetSubtitle() as %String

Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.

• method %OnGetTitle() as %String

Get the (localized) title string for the page.

• method DrawCLASSPATHTable(pPaths) as %Status

Update the contents of the CLASSPATH table

• method GetClassClasspaths(pClassname As %String) as %String [ ZenMethod ]

• classmethod GetClassDefaultLanguageServer(pClassname As %String) as %String [ ZenMethod ]

• classmethod GetClassRemoteClass(pClassname As %String) as %String [ ZenMethod ]

• classmethod GetDefaultDir() as %String [ ZenMethod ]

• method GetFullFilepath(pFilename) as %String [ ZenMethod ]

• classmethod SetDefaultDir(pPathname As %String) [ ZenMethod ]

• method SuggestBounce(pLanguageServer As %String) as %Boolean [ ZenMethod ]

• method SwitchCasingToExistingPackage(pClassname As %String = "", pAddPkgIfNone As %Boolean = 0) as %String [ ZenMethod ]

This method is used to generate an appropriate proxy class name which won't have a classname conflict due to differing cases between an existing package and one used by this class

• method UseIRISHost(pFilename) as %String [ ZenMethod ]

• method addFile() [ Language = javascript ]

• method browseSelect(fileNum) [ Language = javascript ]

User clicked the Browse button.

• method createProxyName() [ Language = javascript ]

• method deleteFile(pNumber) as %Boolean [ ZenMethod ]

• method doBounceOnRegister() [ Language = javascript ]

Invoked when user clicks 'yes' after being prompted about bouncing the ELS This will run instead of ondialogFinish in order to close the dialog.

• method getDialogValue() [ Language = javascript ]

Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.

• method onFileSelect(filename) [ Language = javascript ]

• method onPopupAction(popupName, action, value) [ Language = javascript ]

Returning from file select and setting the value into the appropriate field.

• method ondialogFinish(action) as %Boolean [ Language = javascript ]

This callback is called when the user presses the OK button. If this returns false, then the action is canceled.

• method onloadHandler() [ Language = javascript ]

Trigger keepAlive behaviour for the page.

• method refreshClasspaths() [ Language = javascript ]

Refresh the table which displays the extra CLASSPATHS to use

• method saveFile(pNumber As %Integer, pValue As %String) as %Boolean [ ZenMethod ]

• method setCurrFile(switchTo) [ Language = javascript ]

Set a particular filepath to be editable

• method switchCurrFile(switchTo) [ Language = javascript ]

If there is a filepath being edited, save that first before making another filepath editable Then set the new filepath to be editable

• method userClickedRegister() [ Language = javascript ]

This callback is called when the user presses the OK button. If this returns false, then the action is canceled.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search