EnsPortal.Dialog.DTLFunctionWizard

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

Property Inventory

Method Inventory

Parameters

parameter APPLYBUTTON = 0;
Inherited description: 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");
Property methods: isReplaceDisplayToLogical(), isReplaceGet(), isReplaceIsValid(), isReplaceLogicalToDisplay(), isReplaceLogicalToOdbc(), isReplaceLogicalToXSD(), isReplaceNormalize(), isReplaceSet(), isReplaceXSDToLogical()

Methods

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
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 [ Language = objectscript ]
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the dialog. This should be implemented in a subclass.
classmethod GetFunctions(ByRef pParameters) as %Status [ Language = objectscript ]
clientmethod adjustSize() [ Language = javascript ]
Adjust size and position of components on this page.
clientmethod argChanged(index, isLookup) [ Language = javascript ]
Event handler to update the current expression whenever an argument is changed.
clientmethod 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.
clientmethod getDialogValue() [ Language = javascript ]
Get the value that will be applied when the user presses the OK button.
clientmethod getExpression(expr, includesOpen) [ Language = javascript ]
clientmethod getFunctionList() [ Language = javascript ]
Helper method to get the object tree of defined functions.
clientmethod ondialogStart() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
clientmethod parseExpression(expr, combineDotDotDot) [ Language = javascript ]
clientmethod replaceChanged(newValue) [ Language = javascript ]
Update the isReplace variable when the control is changed.
clientmethod resizeTextControls() [ Language = javascript ]
Ensure that the text controls and the description field expand to fit the width of the window.
clientmethod 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.

Inherited Members

Inherited Properties

Inherited Methods

Feedback