Class %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.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	7	18

Summary

This is a Zen Page class.

Properties
%condition	%import	%includeFiles	%page
%resource	CONTEXT	ELEMENT	Expression
FirstFailed	InvalidParam	IsEMSReadOnly	ValidationErrorMsg
WHAT	align	aux	backgroundTimerInterval
cellAlign	cellSize	cellStyle	cellVAlign
children	composite	containerStyle	cssLevel
cubeName	dataSource	dialogTitle	disabled
disabledStyle	domain	dragAndDrop	dragEnabled
dropEnabled	enclosingClass	enclosingStyle	error
groupClass	groupStyle	height	hidden
hideApplyButton	hideCancelButton	hint	hintClass
hintStyle	id	index	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	name	onafterdrag	onbeforedrag
onclick	ondrag	ondrop	onhide
onrefresh	onshow	onupdate	parent
showLabel	slice	title	tuple
useSVG	useSoftModals	valign	visible
width	window	zenPersistentPopup

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddComponent
%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	%ParseSQLFieldList	%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
GetDataSourceInfo	GetDependsOnInfo	GetPropName	GetSQLNames
HyperEventCall	HyperEventHead	Include	InsertHiddenField
InsertHiddenFields	IsPrivate	JavaInstalled	Link
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
QuoteJS	RewriteURL	ShowError	StartTimer
StopTimer	ThrowError	UnescapeHTML	UnescapeURL
XMLDTD	XMLExport	XMLExportToStream	XMLExportToString
XMLNew	XMLSchema	XMLSchemaNamespace	XMLSchemaType
addChild	addChildAfter	addChildBefore	adjustSize
btnApply	btnOK	cancelPopup	childrenMutated
combineSqlFieldToJSON	combineSqlFieldToString	correctIELayering	createComponent
createComponentNS	ctrlKeyDown	deleteComponent	dialogApply
dialogCancel	dialogFinish	dialogTitleGet	disableButtons
doEdit	doRemove	doUpdate	dragFinishHandler
dragHandler	dragNotifyHandler	dragStartHandler	dropHandler
dropStartHandler	endModal	exposeComponent	findElement
fireOnResizeEvent	fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction
getChildIndex	getComponent	getComponentById	getDialogValue
getEnclosingDiv	getHidden	getHintElement	getLabelElement
getOpener	getProperty	getSettings	getType
gotoPage	invokeSuper	isOfType	launchPopupWindow
makeId	moveItem	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	parseSqlField
popupActionHandler	refreshContents	removeChild	render
renderContents	renderSVG	resetMsg	selectProperty
selectedRow	setComponentId	setHidden	setOverlayMode
setProperty	setPropertyAll	setTraceOption	showMsg
startModal	startProgressBar	stopProgressBar	stripWhitespaces
validateRequired

Parameters

• parameter APPLYBUTTON = 0;

If true, then this dialog displays an Apply button.

Properties

• property CONTEXT as %ZEN.Datatype.string(ZENURL="CONTEXT");

• property ELEMENT as %ZEN.Datatype.string(ZENURL="ELEMENT");

• property Expression as %ZEN.Datatype.string(ZENURL="VALUE");

• property WHAT as %ZEN.Datatype.string(ZENURL="WHAT");

• property cubeName as %ZEN.Datatype.string(ZENURL="CUBE");

Cube name.

• property dataSource as %ZEN.Datatype.string(ZENURL="DATASOURCE");

• property domain as %ZEN.Datatype.string;

Translation domain of the cube

Methods

• method %OnAfterCreatePage() as %Status

Be sure to do ##super() when overriding.

• 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 %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.

• classmethod GetDataSourceInfo(pRoot As %String, Output pTree, ByRef pParms) as %Status

Provide contents of the data source tree.

• classmethod GetDependsOnInfo(pRoot As %String, Output pTree, ByRef pParms) as %Status

• classmethod GetPropName(sourceClass, property, Output propNames) as %String

• 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.

• method 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.

• method 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.

• method doEdit(editObj) [ Language = javascript ]

User edited a field. Change background color and enable Update button.

• method doRemove() [ Language = javascript ]

User clicked the Remove image. Remove the field from Field List box.

• method doUpdate() [ Language = javascript ]

User clicked the Update button. Update the selected row with new value.

• method getDialogValue() [ Language = javascript ]

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

• method 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".

• method parseSqlField(value) [ Language = javascript ]

Parse a JSON string entry in the field list. Return an array with the field identifier and the header.

• method 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.

• method 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.


[USER] > [%DeepSee] > [UI] > [Dialog] > [FieldList]		Private Storage