Class EnsPortal.Dialog.DTLFunctionWizard

class EnsPortal.Dialog.DTLFunctionWizard extends EnsPortal.Dialog.standardDialog

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
4	1	15

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	isReplace	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	GetFunctions	GetHyperEventResources	HyperEventCall
HyperEventHead	Include	InsertHiddenField	InsertHiddenFields
IsPrivate	JavaInstalled	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	argChanged	btnApply	btnOK
cancelPopup	checkEdit	childrenMutated	clientKeepAlive
correctIELayering	createComponent	createComponentNS	ctrlKeyDown
deleteComponent	dialogApply	dialogCancel	dialogFinish
dialogTitleGet	disableButtons	dragFinishHandler	dragHandler
dragNotifyHandler	dragStartHandler	drawArguments	dropHandler
dropStartHandler	endModal	exposeComponent	findElement
fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction
getChildIndex	getComponent	getComponentById	getDialogValue
getEnclosingDiv	getExpression	getFunctionList	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
onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler	onlayoutHandler
onloadHandler	onlogoutHandler	onoverlayHandler	onresizeHandler
onunloadHandler	onupdateHandler	parseExpression	popupActionHandler
refreshContents	removeChild	removePopupSuffix	render
renderContents	renderSVG	replaceChanged	resetMsg
resizeTextControls	setComponentId	setHidden	setOverlayMode
setProperty	setPropertyAll	setTraceOption	showMsg
startKeepAlive	startModal	startProgressBar	stopKeepAlive
stopProgressBar	updateExpression	validateRequired

Parameters

• parameter APPLYBUTTON = 0;

If true, then this dialog displays an Apply button.

• parameter EDITRESOURCE = "%Ens_Code:WRITE,%Ens_DTL:WRITE";

User needs WRITE permissions on either the %Ens_Code or the %Ens_DTL resource to make changes on this page.

• parameter PAGENAME = "Data Transform Function Wizard";

Displayed name of this page.

• parameter RESOURCE = "%Ens_Code:READ,%Ens_DTL:READ";

User needs READ permissions on either the %Ens_Code or the %Ens_DTL resource to view this page.

Properties

• property isReplace as %ZEN.Datatype.boolean(ZENURL="EDIT");

Methods

• method %OnAfterCreatePage() as %Status

This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.

• 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 dialog. This should be implemented in a subclass.

• classmethod GetFunctions(ByRef pParameters) as %Status

• method adjustSize() [ Language = javascript ]

Adjust size and position of components on this page.

• method argChanged(index, isLookup) [ Language = javascript ]

Event handler to update the current expression whenever an argument is changed.

• method drawArguments(functionDesc, noExpressionUpdate) [ Language = javascript ]

Draw the controls for the arguments of the function named in functionDesc. This method is called as an event handler when a new function is chosen and from ondialogStart, where the noExpressionUpdate argument is used to ensure we only update the expression once.

• method getDialogValue() [ Language = javascript ]

Get the value that will be applied when the user presses the OK button.

• method getExpression(expr, includesOpen) [ Language = javascript ]

• method getFunctionList() [ Language = javascript ]

Helper method to get the object tree of defined functions.

• method ondialogStart() [ Language = javascript ]

This callback, if defined, is called when the dialog page is loaded.

• method parseExpression(expr, combineDotDotDot) [ Language = javascript ]

• method replaceChanged(newValue) [ Language = javascript ]

Update the isReplace variable when the control is changed.

• method resizeTextControls() [ Language = javascript ]

Ensure that the text controls and the description field expand to fit the width of the window.

• method updateExpression(newClass, newName) [ Language = javascript ]

Update the expression text displayed at the top of the page. If newClass and newProp are defined, then we initialise the expression as needed. The function should return a boolean to indicate whether the requested update should be processed. The return value will be true in almost all cases, except for a specific case involving function replacement described shortly. If isReplace is true, we replace the current function. As part of the function replacement, we ensure that the expression has the correct number of arguments specified. If the new function has fewer arguments than the user had previously defined, we prompt the user to confirm that they are willing to discard the extra argument(s). If the user indicates that the argument(s) can be discarded, we continue as before. If not, we reset the dropdown and return false, leaving the expression exactly as it is.


[USER] > [EnsPortal] > [Dialog] > [DTLFunctionWizard]		Private Storage