%DeepSee.UI.Dialog.FieldList
Class %DeepSee.UI.Dialog.FieldList Extends %DeepSee.UI.Dialog.standardDialog [ System = 4 ]
This dialog lets the user add or edit the Field List for a Listing.
An existing list (delimited by comma) may be passed in.
Parameters
APPLYBUTTON
Parameter APPLYBUTTON = 0;
Properties
cubeName
Property cubeName As %ZEN.Datatype.string(ZENURL = "CUBE");
Cube name.
ELEMENT
Property ELEMENT As %ZEN.Datatype.string(ZENURL = "ELEMENT");
Expression
Property Expression As %ZEN.Datatype.string(ZENURL = "VALUE");
WHAT
Property WHAT As %ZEN.Datatype.string(ZENURL = "WHAT");
dataSource
Property dataSource As %ZEN.Datatype.string(ZENURL = "DATASOURCE");
CONTEXT
Property CONTEXT As %ZEN.Datatype.string(ZENURL = "CONTEXT");
domain
Property domain As %ZEN.Datatype.string;
Translation domain of the cube
XDatas
Style
XData Style
dialogBody
XData dialogBody [ XMLNamespace = "http://www.intersystems.com/zen" ]
Contents of the dialog body.
Methods
%OnGetTitle
Method %OnGetTitle() As %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
%OnGetSubtitle
Method %OnGetSubtitle() As %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
getDialogValue
ClientMethod getDialogValue() [ Language = javascript ]
doEdit
ClientMethod doEdit(editObj) [ Language = javascript ]
User edited a field. Change background color and enable Update button.
doRemove
ClientMethod doRemove() [ Language = javascript ]
User clicked the Remove image. Remove the field from Field List box.
doUpdate
ClientMethod doUpdate() [ Language = javascript ]
User clicked the Update button. Update the selected row with new value.
moveItem
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".
selectProperty
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.
parseSqlField
ClientMethod parseSqlField(value) [ Language = javascript ]
Parse a JSON string entry in the field list. Return an array with the field identifier and the header.
combineSqlFieldToJSON
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.
combineSqlFieldToString
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.
selectedRow
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.
%OnAfterCreatePage
Method %OnAfterCreatePage() As %Status
GetDataSourceInfo
ClassMethod GetDataSourceInfo(pRoot As %String, Output pTree, ByRef pParms) As %Status
Provide contents of the data source tree.
GetDependsOnInfo
ClassMethod GetDependsOnInfo(pRoot As %String, Output pTree, ByRef pParms) As %Status
GetSQLNames
ClassMethod GetSQLNames(sourceClass As %String, fullName As %String, WHAT As %String) As %ZEN.proxyObject [ ZenMethod ]
Get SQL Names from property name. Similar logic as in IsDate of Architect.
GetPropName
ClassMethod GetPropName(sourceClass, property, Output propNames) As %String
%ParseSQLFieldList
ClassMethod %ParseSQLFieldList(pFieldString = "", pDomain = "", Output pFieldArray) As %Status
Split a single fieldList string into the individual fields. This is more sophisticated than a simple comma-delimited split.