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

class %DeepSee.UI.CaptionEditor extends %DeepSee.UI.standardPage

DeepSee Caption Editor page.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 10 20


Summary

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

Properties
%condition %import %includeFiles %page
%resource StdTitle aboutPage align
aux backgroundTimerInterval canWrite cellAlign
cellSize cellStyle cellVAlign children
composite contactPage containerStyle cssLevel
cubeFullName cubeName currCaption currContext
currDim currHier currLevel currProp
currSortMode currStep currViewMode disabled
docbookId dragAndDrop dragEnabled dropEnabled
enableAutoRefresh enclosingClass enclosingStyle error
groupClass groupStyle height hidden
hint hintClass hintStyle homePage
id index label labelClass
labelDisabledClass labelPosition labelStyle layout
limitPopups name onafterdrag onbeforedrag
onclick ondrag ondrop onhide
onrefresh onshow onupdate pageModified
parent readOnly searchKey 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 %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 BuildMenu CheckContextLinks CheckEnterpriseManager
ConvertParameter Decrypt DeleteItem DoLogout
DrawCubeName DrawLocator DrawRibbon DrawTitle
Encrypt EscapeHTML EscapeURL GetCSPURL
GetContextLinks GetDimensionInfo GetDocPage GetNewURL
GetQuickLinks HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate Link
OnDrawRibbon OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page ParseValue QuoteJS
RewriteURL SaveItem ShowError StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore adjustSizes
cancelPopup changePassword changeSubjectArea childrenMutated
contextChange correctIELayering createComponent createComponentNS
deleteCaption deleteComponent disableCommandButton dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dropHandler
dropStartHandler enableCommandButton endModal exposeComponent
findElement fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getChildIndex getComponent getComponentById
getEnclosingDiv getHidden getHintElement getLabelElement
getOpener getPageTitle getProperty getSettings
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPage hideCommandButton invokeSuper
isOfType launchPopupWindow logout makeId
navigate onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondisabledHandler onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler popupActionHandler refreshContents
reloadPage removeChild render renderContents
renderSVG saveCaption searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress setComponentId
setConnectivityStatusMsg setHidden setModified setOverlayMode
setPageTitle setProperty setPropertyAll setSortMode
setSortModeHandler setTraceOption setViewMode setViewModeHandler
showAbout showCommandButton showContact showHelp
startModal startProgressBar stopProgressBar switchNamespace
treeChange


Parameters

• parameter PAGENAME = "Caption Editor";
Name of this page.

Properties

• property canWrite as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, user can modify (non-read-only) pivots.
• property cubeFullName as %ZEN.Datatype.string(ZENURL="CUBE");
Parameter DOCBOOKID = "D2ANLY_ch_intro"; Name of Cube (with extension).
• property cubeName as %ZEN.Datatype.string;
Name of cube to explore.
• property currCaption as %ZEN.Datatype.string;
Current caption.
• property currContext as %ZEN.Datatype.string;
Current context.
• property currDim as %ZEN.Datatype.string;
Current dimension.
• property currHier as %ZEN.Datatype.string;
Current hierarchy.
• property currLevel as %ZEN.Datatype.string;
Current level.
• property currProp as %ZEN.Datatype.string;
Current property.
• property readOnly as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, user cannot modify captions.

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 %OnGetPageName() as %String
Get the name for 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.
• classmethod DeleteItem(pCube As %String, pContext As %String, pDim As %String, pHier As %String, pLevel As %String, pProp As %String) as %String [ ZenMethod ]
Delete a caption.
• method DrawCubeName(pSeed As %String) as %Status
Draw cube name above member tree.
• classmethod GetDimensionInfo(pRoot As %String, Output pTree, ByRef pParms) as %Status
Provide contents of the dimension tree.
• 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.
• classmethod ParseValue(pCube As %String, pContext As %String, pValue As %String) as %String [ ZenMethod ]
Pull apart the given member spec.
• classmethod SaveItem(pCube As %String, pContext As %String, pDim As %String, pHier As %String, pLevel As %String, pProp As %String, pCaption As %String) as %String [ ZenMethod ]
Save a caption.
• method adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
• method changeSubjectArea() [ Language = javascript ]
Launch the subject area finder dialog.
• method contextChange(ctx) [ Language = javascript ]
User has selected a new context.
• method deleteCaption() [ Language = javascript ]
Delete the current caption.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when a popup page launched from this page fires an action.
• method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
• method saveCaption() [ Language = javascript ]
Save the current caption.
• method treeChange(tree) [ Language = javascript ]
User has selected a new element in the tree control.


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