%DeepSee.UI.Dialog.FieldList

class %DeepSee.UI.Dialog.FieldList extends %DeepSee.UI.Dialog.standardDialog

This dialog lets the user add or edit the Field List for a Listing.
An existing list (delimited by comma) may be passed in.

Property Inventory

Method Inventory

Parameters

parameter APPLYBUTTON = 0;
Inherited description: If true, then this dialog displays an Apply button.

Properties

property CONTEXT as %ZEN.Datatype.string (ZENURL = "CONTEXT");
Property methods: CONTEXTDisplayToLogical(), CONTEXTGet(), CONTEXTIsValid(), CONTEXTLogicalToDisplay(), CONTEXTLogicalToOdbc(), CONTEXTNormalize(), CONTEXTSet()
property ELEMENT as %ZEN.Datatype.string (ZENURL = "ELEMENT");
Property methods: ELEMENTDisplayToLogical(), ELEMENTGet(), ELEMENTIsValid(), ELEMENTLogicalToDisplay(), ELEMENTLogicalToOdbc(), ELEMENTNormalize(), ELEMENTSet()
property Expression as %ZEN.Datatype.string (ZENURL = "VALUE");
Property methods: ExpressionDisplayToLogical(), ExpressionGet(), ExpressionIsValid(), ExpressionLogicalToDisplay(), ExpressionLogicalToOdbc(), ExpressionNormalize(), ExpressionSet()
property WHAT as %ZEN.Datatype.string (ZENURL = "WHAT");
Property methods: WHATDisplayToLogical(), WHATGet(), WHATIsValid(), WHATLogicalToDisplay(), WHATLogicalToOdbc(), WHATNormalize(), WHATSet()
property cubeName as %ZEN.Datatype.string (ZENURL = "CUBE");
Cube name.
Property methods: cubeNameDisplayToLogical(), cubeNameGet(), cubeNameIsValid(), cubeNameLogicalToDisplay(), cubeNameLogicalToOdbc(), cubeNameNormalize(), cubeNameSet()
property dataSource as %ZEN.Datatype.string (ZENURL = "DATASOURCE");
Property methods: dataSourceDisplayToLogical(), dataSourceGet(), dataSourceIsValid(), dataSourceLogicalToDisplay(), dataSourceLogicalToOdbc(), dataSourceNormalize(), dataSourceSet()
property domain as %ZEN.Datatype.string;
Translation domain of the cube
Property methods: domainDisplayToLogical(), domainGet(), domainIsValid(), domainLogicalToDisplay(), domainLogicalToOdbc(), domainNormalize(), domainSet()

Methods

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: Be sure to do ##super() when overriding.
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 %ParseSQLFieldList(pFieldString="", pDomain="", Output pFieldArray) as %Status [ Language = objectscript ]
Split a single fieldList string into the individual fields. This is more sophisticated than a simple comma-delimited split.
classmethod GetDataSourceInfo(pRoot As %String, Output pTree, ByRef pParms) as %Status [ Language = objectscript ]
Provide contents of the data source tree.
classmethod GetDependsOnInfo(pRoot As %String, Output pTree, ByRef pParms) as %Status [ Language = objectscript ]
classmethod GetPropName(sourceClass, property, Output propNames) as %String [ Language = objectscript ]
classmethod GetSQLNames(sourceClass As %String, fullName As %String, WHAT As %String) as %ZEN.proxyObject [ Language = objectscript, ZenMethod ]
Get SQL Names from property name. Similar logic as in IsDate of Architect.
clientmethod combineSqlFieldToJSON(useDomain, parsedFieldArray) [ Language = javascript ]
Produce a JSON string for the complete parsed field entry by combining the Field and Header information into something of the form
Field AS "$$$TEXT["Header","DOMAIN"]"
If there is no Domain defined for the cube, the $$$TEXT[] will be omitted. Delimited identifiers are always assumed and the double quotes are always added to the Header portion.
clientmethod combineSqlFieldToString(useDomain, parsedFieldArray) [ Language = javascript ]
Produce a display string for the complete field entry by combining the Field and Header information into something of the form
Field AS "$$$TEXT["Header","DOMAIN"]"
If there is no Domain defined for the cube, the $$$TEXT[] will be omitted. Delimited identifiers are always assumed and the double quotes are always added to the Header portion.
clientmethod doEdit(editObj) [ Language = javascript ]
User edited a field. Change background color and enable Update button.
clientmethod doRemove() [ Language = javascript ]
User clicked the Remove image. Remove the field from Field List box.
clientmethod doUpdate() [ Language = javascript ]
User clicked the Update button. Update the selected row with new value.
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 moveItem(dir) [ Language = javascript ]
User clicked the Move Up/Down image. Move the field up or down one level in the Field List box. dir = "up" or "dn".
clientmethod parseSqlField(value) [ Language = javascript ]
Parse a JSON string entry in the field list. Return an array with the field identifier and the header.
clientmethod selectProperty(sourceObj) [ Language = javascript ]
User selected a property from the tree. Get the SQLName for the selected value and put it into the Field List box.
clientmethod selectedRow(fieldObj) [ Language = javascript ]
User clicked a row from the list box. Parse selected value and place it into the Field and Header boxes for editing.

Inherited Members

Inherited Properties

Inherited Methods

Feedback