SchemaMap.Tool.UI.File

class SchemaMap.Tool.UI.File extends %ZEN.Dialog.standardDialog

DATA (DataName) takes precedence over NAME. It must be the name of a method in the class SchemaMap.Tool.Data.Message that returns a %String value. The entire contents of that %String are displayed without modification.

NAME (FileName) must be the name of a file in the local file system. The entire contents of that file are displayed without modification.

Property Inventory

• DataName
• FileName

Method Inventory

• %OnGetSubtitle()
• %OnGetTitle()
• drawFileContent()
• getDialogValue()
• ondialogFinish()

Parameters

parameter APPLYBUTTON = 0;

Inherited description: If true, then this dialog displays an Apply button.

parameter CANCELBUTTON = 0;

Inherited description: If true, then this dialog displays a Cancel button.

parameter RESOURCE = %Ens_EDISchemaAnnotations:READ;

Inherited description: This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

Properties

property DataName as %String (ZENURL = "DATA");

Property methods: DataNameDisplayToLogical(), DataNameGet(), DataNameIsValid(), DataNameLogicalToDisplay(), DataNameLogicalToOdbc(), DataNameNormalize(), DataNameSet()

property FileName as %String (ZENURL = "NAME");

Property methods: FileNameDisplayToLogical(), FileNameGet(), FileNameIsValid(), FileNameLogicalToDisplay(), FileNameLogicalToOdbc(), FileNameNormalize(), FileNameSet()

Methods

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.

method drawFileContent(seed As %String) as %Status

clientmethod getDialogValue() [ Language = javascript ]

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

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

This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.