Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%DeepSee] >  [UI] >  [ArchitectSA]
Private  Storage   

class %DeepSee.UI.ArchitectSA extends %DeepSee.UI.standardPage, %CSP.Portal.SourceControl.Base

DeepSee SubjectArea Architect page. This is a special version of the Architect for operating on Subject Areas.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 24 75


Summary

This is a Zen Page class. It belongs to the application %ZEN.Portal.Application.

Properties
%basecube %condition %import %includeFiles
%model %page %resource DocumaticPage
StdTitle aboutPage align aux
backgroundTimerInterval baseCube canEdit canWrite
cellAlign cellSize cellStyle cellVAlign
children composite contactPage containerStyle
cssLevel currItem currItemType currSortMode
currStep currViewMode currentNamespace currentProject
currentUser dataSource disabled docbookId
dragAndDrop dragEnabled dropEnabled enableAutoRefresh
enclosingClass enclosingStyle error groupClass
groupStyle hasSCOutput height hidden
hint hintClass hintStyle hlpRemove
hlpShowHide homePage id index
label labelClass labelDisabledClass labelPosition
labelStyle layout lblDimension lblHier
lblLevel lblListing lblMeasure limitPopups
msgInvalid msgNotPermitted name needProject
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate pageModified parent readOnly
readOnlyReason renamed searchKey showLabel
slice sourceControlEnabled sourceControlManagerDialog sourceControlNewlineFormat
sourceControlOutputDialog sourceControlVisible subjectAreaClass subjectAreaDependsOn
subjectAreaDescription subjectAreaDomain subjectAreaFullName subjectAreaName
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 %DrawSourceControlCommands %DrawSourceControlHead
%DrawSourceControlJS %DrawSourceControlStyle %EnclosingDivId %EndBackgroundMethod
%EndScript %Eval %EvalC %Extends
%ForceClientRender %GetChildIndex %GetComponent %GetComponentById
%GetComponentByName %GetEventHandlers %GetLinks %GetLocatorLinks
%GetPageName %GetParameter %GetRootLink %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
%OnGetPageName %OnGetProductName %OnGetSmallMenu %OnGetTitle
%OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch %OnPreHTTP
%OnSubmit %OnUseSoftModals %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %Register
%RemoveChild %RemoveChildren %RemoveComponent %RemoveFromSaveSet
%RunBackgroundMethod %Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %StartScript %ValidateObject
%ZENVersion AfterUserAction AppendSourceControlOutput BuildMenu
CheckContextLinks CheckEnterpriseManager ClearSourceControlOutput ConvertParameter
CreateProject CreateSourceControl Decrypt DoLogout
DocumentLoad DocumentSave DrawLocator DrawRibbon
DrawTableHeader DrawTitle Encrypt EscapeHTML
EscapeURL GetCSPURL GetContextLinks GetCubeDefinition
GetCurrentProject GetDocPage GetFullProjectName GetInternalName
GetNewURL GetQuickLinks GetSourceControlClass GetSourceControlCommands
GetSubjectAreaDefinition GetTimestamp HaveSourceControlOutput HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsEnabled IsPrivate IsProjectRequired IsSourceControlReadOnly
Link LoadDefaultList LoadListingSource LoadProject
OnDrawRibbon OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RewriteURL
SetCurrentProject SetProjectRequired ShowError StartTimer
StopTimer SubmitSubjectArea ThrowError UnescapeHTML
UnescapeURL UpdateSCMenus UserAction XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore addItem addNewItemToModel
addUndoAction adjustSizes appendServerOutput applyDependsOn
applyDescription applyDetails applyDomain browseClass
canUndo canUserModify cancelDetailForm cancelPopup
changePassword changeSubjectArea changeUndoState changeUseSQL
checkTextControls childrenMutated chooseSCMenu chooseSCProject
clearSCOutput clearUndoBuffer cloneObject compile
correctIELayering createComponent createComponentNS createDim
createHier createLevel createSCMenuItem createSCProject
createSCSubMenu deleteComponent diffDimensions diffHierarchies
diffLevels diffMeasures dimHasAll disableCommandButton
doDocument dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler editDescription
editItem enableCommandButton enableItem endModal
exposeComponent findElement findRowForItem fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getCSSForType
getChildIndex getClientModel getComponent getComponentById
getCubeObject getCurrentExtension getCurrentName getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getPageTitle getProperty getReadOnlyReason getSaveAction
getSelectedItem getSettings getSubjectAreaObject getTitleAreaHeight
getType goHome goMenu gotoNamespace
gotoPage hideCommandButton initializeSourceControl initializeTextMonitor
invokeAfterUserAction invokeSourceControl invokeSuper isOfType
launchPopupWindow loadDocument logout makeId
maxDiff navigate newSubjectArea onCreate
onDelete onDisplayHandler onDocumentLoad onDocumentLoadComplete
onDocumentSave onDocumentSaveComplete onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler ondisabledHandler onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler onupdateHandler
popupActionHandler refreshContents reloadDocument reloadPage
removeChild removeItem render renderContents
renderSVG renderTable rowClick save
saveCube saveDocument searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress selectItem
selectNewItem setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setPageTitle setProperty
setPropertyAll setReadOnly setSCProject setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
showAbout showCommandButton showContact showHelp
showSCMenu showSCOutput startModal startProgressBar
stopProgressBar switchNamespace textControlKeyDown textControlKeyUp
toggleDisclosure toggleSettings toolAnalyzer toolQuery
undo updateDiff updateDocumentState updateSCIndicator
updateTable viewSub


Parameters

• parameter DEFAULTVIEWMODE = "cube";
If this page has multiple views, this is its initial display mode.
• parameter DOCBOOKID = "D2MODEL_intro_architect";
Docbook ID for this page.
• parameter PAGENAME = "Architect Subject Area";
Displayed name of this page.

Properties

• property %basecube as %DeepSee.Model.SubjectArea.subjectArea;
Local copy of BaseCube model object.
• property %model as %DeepSee.Model.SubjectArea.subjectArea;
Local copy of SubjectArea model object.
• property DocumaticPage as %String;
• property baseCube as %ZEN.Datatype.string;
Base cube name for the current subject area.
• property canWrite as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, user can modify (non-read-only) SubjectArea definitions, otherwise they can only view.
• property currItem as %ZEN.Datatype.integer [ InitialExpression = -1 ];
ID (index number, 0-based) of current selected item.
• property currItemType as %ZEN.Datatype.string;
Type of the current selected item.
• property dataSource as %ZEN.Datatype.string;
Data source. This is a copy of the value in the base cube model.
• property hlpRemove as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Remove this item") ];
• property hlpShowHide as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Hide or show the properties box") ];
• property lblDimension as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("dimension") ];
• property lblHier as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("hierarchy") ];
• property lblLevel as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("level") ];
• property lblListing as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("listing") ];
• property lblMeasure as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("measure") ];
• property msgInvalid as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please click [Open] to select a model definition.") ];
• property readOnly as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, user cannot modify the current SubjectArea definition.
• property subjectAreaClass as %ZEN.Datatype.string;
Class name of SubjectArea being viewed. This is determined from the SubjectArea name.
• property subjectAreaDependsOn as %ZEN.Datatype.string;
DependsOn for subjectArea class. If provided, this is used as the DependsOn value of the generated subjectArea. If not, the base cube for the subjectArea is used. This is handled seperately from json.
• property subjectAreaDescription as %ZEN.Datatype.string;
Description of SubjectArea being viewed. This is determined from the subjectArea name.
• property subjectAreaDomain as %ZEN.Datatype.string;
Domain of SubjectArea being viewed. This is handled seperately from json.
• property subjectAreaFullName as %ZEN.Datatype.string(ZENURL="CUBE");
Name of SubjectArea (with extension).
• property subjectAreaName as %ZEN.Datatype.string;
Name of SubjectArea being viewed.

Methods

• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
• method %OnAfterCreatePage() as %Status
This class method callback is called just before the server-side page object is created.
• method %OnDrawHTMLHead() as %Status
This callback is called at the end of the HTML HEAD section of the page.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetProductName() as %String
Get the product name for the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page. This should be implemented in a subclass.
• method DrawTableHeader(pSeed As %String) as %Status
Draw the contents of the Table Header (the region between the diagram and the table).
• method GetCubeDefinition(ByRef pParms, Output pBase As %RegisteredObject) as %Status
Get BaseCube definition for JSON provider.
• method GetInternalName() as %String
Return the internal name of the current document, including the three letter extension in upper-case. For example, MyPackage.MyClass.CLS would be the internal name for the class MyPackage.MyClass.
• method GetSubjectAreaDefinition(ByRef pParms, Output pObject As %RegisteredObject) as %Status
Get SubjectArea definition for JSON provider.
• method LoadDefaultList(baseCube, pType) as %String
Return Measure list or Listing list
• method LoadListingSource() as %String
Return Data Connector list
• method OnDrawRibbon() as %Status
Draw additional stuff in the ribbon bar
• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
• method SubmitSubjectArea(pCommand As %String, pProvider As %ZEN.Auxiliary.jsonProvider, pSubmitObject As %RegisteredObject, ByRef pResponseObject As %RegisteredObject) as %Status
Object submit handler JSON provider. This is called when the client submits the Subject Area definition.
• method addItem() [ Language = javascript ]
Invoke dialog to add a new item to the model.
• method addNewItemToModel(typenewname) [ Language = javascript ]
Add a new item to the model and select it.
• method addUndoAction() [ Language = javascript ]
Remember the current state in the undo buffer.
• method adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
• method applyDependsOn(value) [ Language = javascript ]
user modified DependsOn. Since it is not part of json, handle it seperately.
• method applyDescription(what) [ Language = javascript ]
Set textarea description back into the text description field.
• method applyDetails() [ Language = javascript ]
Apply changes from detail form.
• method applyDomain(value) [ Language = javascript ]
user modified Domain. Since it is not part of json, handle it seperately.
• method browseClass(popupName) [ Language = javascript ]
Invoke class finder dialog. popupName="sourceclasses" or "cubes"
• method canUndo() [ Language = javascript ]
Return true if it is possible to undo an action
• method canUserModify() [ Language = javascript ]
Test if the user has write privilege.
• method cancelDetailForm() [ Language = javascript ]
Cancel changes from detail form.
• method changeSubjectArea() [ Language = javascript ]
Launch the subjectArea finder dialog.
• method changeUndoState(undostate) [ Language = javascript ]
Change Undo button state and View button state (opposite of Undo button)
• method changeUseSQL() [ Language = javascript ]
User checked/unchecked the Use SQL field
• method clearUndoBuffer() [ Language = javascript ]
• method cloneObject(obj, clone) [ Language = javascript ]
Create a clone of the given object.
• method compile() [ Language = javascript ]
Compile the cube.
• method createDim(newname) [ Language = javascript ]
• method createHier(newname) [ Language = javascript ]
• method createLevel(newname) [ Language = javascript ]
• method diffDimensions(itemObj, baseObj) [ Language = javascript ]
Check overrides for Dimension
• method diffHierarchies(itemObj, baseObj) [ Language = javascript ]
Check overrides for Hierarchies
• method diffLevels(itemObj, baseObj) [ Language = javascript ]
Check overrides for Levels
• method diffMeasures(itemObj, baseObj) [ Language = javascript ]
Check overrides for Measure
• method dimHasAll(item) [ Language = javascript ]
Find if this baseCube's dimension property hasAll is true or false. If false, then do not show the all members fields.
• method doDocument() [ Language = javascript ]
Open Documatic page to view all details (if user has not modified anything).
• method editDescription(what) [ Language = javascript ]
Toggle to show/hide Description textarea; set what's in text into textarea.
• method editItem(what) [ Language = javascript ]
Invoke dialog to edit certain items: RangeExpression, FormatString, SourceProperty, SourceExpression.
• method enableItem(row, flag) [ Language = javascript ]
Enable/disable a row in the table.
• method findRowForItem(item) [ Language = javascript ]
Find the row number in the table for the given model item. This must be called after the table has been rendered.
• method getCSSForType(type) [ Language = javascript ]
Find the css class for the given row type.
• method getClientModel() [ Language = javascript ]
Get the jsonProvider object on the client.
• method getCubeObject() [ Language = javascript ]
Return the cube definition object.
• method getCurrentName() [ Language = javascript ]
Return the current name of the class/object being modified.
• method getSelectedItem() [ Language = javascript ]
Return the current selected item.
• method getSubjectAreaObject() [ Language = javascript ]
Return the subject area definition object.
• method maxDiff(diffString) [ Language = javascript ]
• method newSubjectArea() [ Language = javascript ]
Invoke dialog to add a new subjectArea.
• method onDocumentLoadComplete() [ Language = javascript ]
Callback method invoked after we have successfully loaded the current document.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
• method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
• method onloadHandler() [ Language = javascript ]
Add check to ensure that we correctly load documents on the client when source control hooks are in use. Also set up a timer to ensure we don't hit timeouts while editing documents in Studio, as well as When in Studio mode, also detect whether we are running IE10, as we need to save documents differently if that is the case.
• method removeItem(type, row, index, hier, level, prop) [ Language = javascript ]
Remove a row from the table.
• method renderTable() [ Language = javascript ]
Update the contents of the model table.
• method rowClick(type, row) [ Language = javascript ]
User click on a row in the table.
• method save() [ Language = javascript ]
Save the cube.
• method saveCube() [ Language = javascript ]
Do save now. This method is called from compile also.
• method selectItem(type, row, force) [ Language = javascript ]
Select a row in the table.
• method selectNewItem(newItem, newType) [ Language = javascript ]
Helper method: select an item, make sure it is visible and give focus to the details panel.
• method setReadOnly(readOnly) [ Language = javascript ]
method used by Source Control to set the value of the readOnly flag.
• method setViewModeHandler(mode) [ Language = javascript ]
Do the actual work of updating the view to match the current view mode.
• method toggleDisclosure(key) [ Language = javascript ]
User click on disclosure icon in table.
• method toggleSettings() [ Language = javascript ]
Toggle display of settings (property tabs) box.
• method toolAnalyzer() [ Language = javascript ]
Show analyzer in a new window.
• method toolQuery() [ Language = javascript ]
Show query tool in a new window.
• method undo() [ Language = javascript ]
Undo the most recent change.
• method updateDiff(diffString, propName) [ Language = javascript ]
• method updateTable() [ Language = javascript ]
Update the contents of the model table.
• method viewSub() [ Language = javascript ]
Open View Cube page to view all details (if user has not modified anything).


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.