%DeepSee.UI.CaptionEditor
class %DeepSee.UI.CaptionEditor extends %DeepSee.UI.standardPage
DeepSee Caption Editor page.Property Inventory
Method Inventory
- %GetLocatorLinks()
 - %OnAfterCreatePage()
 - %OnGetPageName()
 - %OnGetProductName()
 - %OnGetTitle()
 - DeleteItem()
 - DrawCubeName()
 - GetDimensionInfo()
 - OnDrawRibbon()
 - OnGetRibbonInfo()
 - ParseValue()
 - SaveItem()
 - adjustSizes()
 - changeSubjectArea()
 - contextChange()
 - deleteCaption()
 - onPopupAction()
 - onlayoutHandler()
 - saveCaption()
 - treeChange()
 
Parameters
parameter PAGENAME = Caption Editor;
Inherited description: Name of this page.
Properties
property canWrite as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, user can modify (non-read-only) pivots.
Property methods: canWriteDisplayToLogical(), canWriteGet(), canWriteIsValid(), canWriteLogicalToDisplay(), canWriteLogicalToOdbc(), canWriteLogicalToXSD(), canWriteNormalize(), canWriteSet(), canWriteXSDToLogical()
property cubeFullName as %ZEN.Datatype.string (ZENURL = "CUBE");
Parameter DOCBOOKID = "D2ANLY_ch_intro";
Name of Cube (with extension).
Property methods: cubeFullNameDisplayToLogical(), cubeFullNameGet(), cubeFullNameIsValid(), cubeFullNameLogicalToDisplay(), cubeFullNameLogicalToOdbc(), cubeFullNameNormalize(), cubeFullNameSet()
property cubeName as %ZEN.Datatype.string;
Name of cube to explore.
Property methods: cubeNameDisplayToLogical(), cubeNameGet(), cubeNameIsValid(), cubeNameLogicalToDisplay(), cubeNameLogicalToOdbc(), cubeNameNormalize(), cubeNameSet()
property currCaption as %ZEN.Datatype.string;
Current caption.
Property methods: currCaptionDisplayToLogical(), currCaptionGet(), currCaptionIsValid(), currCaptionLogicalToDisplay(), currCaptionLogicalToOdbc(), currCaptionNormalize(), currCaptionSet()
property currContext as %ZEN.Datatype.string;
Current context.
Property methods: currContextDisplayToLogical(), currContextGet(), currContextIsValid(), currContextLogicalToDisplay(), currContextLogicalToOdbc(), currContextNormalize(), currContextSet()
property currDim as %ZEN.Datatype.string;
Current dimension.
Property methods: currDimDisplayToLogical(), currDimGet(), currDimIsValid(), currDimLogicalToDisplay(), currDimLogicalToOdbc(), currDimNormalize(), currDimSet()
property currHier as %ZEN.Datatype.string;
Current hierarchy.
Property methods: currHierDisplayToLogical(), currHierGet(), currHierIsValid(), currHierLogicalToDisplay(), currHierLogicalToOdbc(), currHierNormalize(), currHierSet()
property currLevel as %ZEN.Datatype.string;
Current level.
Property methods: currLevelDisplayToLogical(), currLevelGet(), currLevelIsValid(), currLevelLogicalToDisplay(), currLevelLogicalToOdbc(), currLevelNormalize(), currLevelSet()
property currProp as %ZEN.Datatype.string;
Current property.
Property methods: currPropDisplayToLogical(), currPropGet(), currPropIsValid(), currPropLogicalToDisplay(), currPropLogicalToOdbc(), currPropNormalize(), currPropSet()
property readOnly as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, user cannot modify captions.
Property methods: readOnlyDisplayToLogical(), readOnlyGet(), readOnlyIsValid(), readOnlyLogicalToDisplay(), readOnlyLogicalToOdbc(), readOnlyLogicalToXSD(), readOnlyNormalize(), readOnlySet(), readOnlyXSDToLogical()
Methods
method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
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.
Draw cube name above member tree.
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.
clientmethod adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod changeSubjectArea() [ Language = javascript ]
Launch the subject area finder dialog.
clientmethod contextChange(ctx) [ Language = javascript ]
User has selected a new context.
clientmethod deleteCaption() [ Language = javascript ]
Delete the current caption.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when a popup page launched from this page fires an action.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod saveCaption() [ Language = javascript ]
Save the current caption.
clientmethod treeChange(tree) [ Language = javascript ]
User has selected a new element in the tree control.
Inherited Members
Inherited Properties
- %condition
 - %import
 - %includeFiles
 - %page
 - %resource
 - StdTitle
 - aboutPage
 - align
 - aux
 - backgroundTimerInterval
 - cellAlign
 - cellSize
 - cellStyle
 - cellVAlign
 - children
 - composite
 - contactPage
 - containerStyle
 - cssLevel
 - 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
 - metaData
 - name
 - onafterdrag
 - onbeforedrag
 - onclick
 - ondrag
 - ondrop
 - onhide
 - onrefresh
 - onshow
 - onupdate
 - pageModified
 - parent
 - searchKey
 - showLabel
 - slice
 - title
 - tuple
 - useSVG
 - useSoftModals
 - valign
 - visible
 - width
 - window
 - zenPersistentPopup
 
Inherited 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()
 - %GetPageName()
 - %GetParameter()
 - %GetRootLink()
 - %GetValueById()
 - %GetValueByName()
 - %GetXMLName()
 - %IsA()
 - %IsModified()
 - %Link()
 - %LinkCSS()
 - %LinkScript()
 - %MakeId()
 - %New()
 - %NormalizeObject()
 - %ObjectModified()
 - %OnAddToPageAfter()
 - %OnAddToPageBefore()
 - %OnBeforeCreatePage()
 - %OnCreateApplication()
 - %OnCreatePage()
 - %OnDetermineCSSLevel()
 - %OnDrawEnclosingDiv()
 - %OnDrawHTMLBody()
 - %OnDrawHTMLHead()
 - %OnDrawHTMLMeta()
 - %OnDrawObjectProperties()
 - %OnFinishBackgroundTask()
 - %OnGetSmallMenu()
 - %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()
 - DoLogout()
 - DrawLocator()
 - DrawRibbon()
 - DrawTitle()
 - Encrypt()
 - EscapeHTML()
 - EscapeURL()
 - GetCSPURL()
 - GetContextLinks()
 - GetDocURL()
 - GetNewURL()
 - GetQuickLinks()
 - HyperEventCall()
 - HyperEventHead()
 - Include()
 - InsertHiddenField()
 - InsertHiddenFields()
 - IsPrivate()
 - JavaInstalled()
 - Link()
 - OnHTTPHeader()
 - OnPage()
 - OnPageError()
 - OnPostHTTP()
 - OnPostHyperEvent()
 - OnPreHTTP()
 - OnPreHyperEvent()
 - Page()
 - QuoteJS()
 - ReallyClearEscalation()
 - RewriteURL()
 - ShowError()
 - StartTimer()
 - StopTimer()
 - ThrowError()
 - UnescapeHTML()
 - UnescapeURL()
 - XMLDTD()
 - XMLExport()
 - XMLExportToStream()
 - XMLExportToString()
 - XMLNew()
 - XMLSchema()
 - XMLSchemaNamespace()
 - XMLSchemaType()
 - addChild()
 - addChildAfter()
 - addChildBefore()
 - cancelPopup()
 - changePassword()
 - childrenMutated()
 - clearEscalation()
 - correctIELayering()
 - createComponent()
 - createComponentNS()
 - deleteComponent()
 - disableCommandButton()
 - dragFinishHandler()
 - dragHandler()
 - dragNotifyHandler()
 - dragStartHandler()
 - dropHandler()
 - dropStartHandler()
 - enableCommandButton()
 - endModal()
 - escalateLogin()
 - exposeComponent()
 - findElement()
 - fireOnResizeEvent()
 - fireOnUnloadEvent()
 - fireOnUpdateEvent()
 - firePopupAction()
 - getChildIndex()
 - getComponent()
 - getComponentById()
 - getEnclosingDiv()
 - getHidden()
 - getHintElement()
 - getLabelElement()
 - getOpener()
 - getPageMeta()
 - getPageTitle()
 - getProperty()
 - getSettings()
 - getTitleAreaHeight()
 - getType()
 - goHome()
 - goMenu()
 - gotoNamespace()
 - gotoPage()
 - hideCommandButton()
 - invokeSuper()
 - isOfType()
 - launchPopupWindow()
 - logout()
 - makeId()
 - navigate()
 - onCreate()
 - onDelete()
 - onDisplayHandler()
 - onEndModalHandler()
 - onRefreshContents()
 - onSerialize()
 - onServerMethodCall()
 - onServerMethodError()
 - onServerMethodReturn()
 - onStartModalHandler()
 - ondisabledHandler()
 - onhandleAutoLogoutWarn()
 - onkeydownHandler()
 - onkeyupHandler()
 - onloadHandler()
 - onlogoutHandler()
 - onoverlayHandler()
 - onresizeHandler()
 - onunloadHandler()
 - onupdateHandler()
 - popupActionHandler()
 - refreshContents()
 - reloadPage()
 - removeChild()
 - render()
 - renderContents()
 - renderSVG()
 - 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()