Skip to main content

%DeepSee.UI.CaptionEditor

Class %DeepSee.UI.CaptionEditor Extends %DeepSee.UI.standardPage [ System = 4 ]

DeepSee Caption Editor page.

Parameters​

PAGENAME​

Parameter PAGENAME = "Caption Editor";

Properties​

cubeFullName​

Property cubeFullName As %ZEN.Datatype.string(ZENURL = "CUBE");

Parameter DOCBOOKID = "D2ANLY_ch_intro"; Name of Cube (with extension).

cubeName​

Property cubeName As %ZEN.Datatype.string;

Name of cube to explore.

canWrite​

Property canWrite As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

If true, user can modify (non-read-only) pivots.

readOnly​

Property readOnly As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, user cannot modify captions.

currContext​

Property currContext As %ZEN.Datatype.string;

Current context.

currDim​

Property currDim As %ZEN.Datatype.string;

Current dimension.

currHier​

Property currHier As %ZEN.Datatype.string;

Current hierarchy.

currLevel​

Property currLevel As %ZEN.Datatype.string;

Current level.

currProp​

Property currProp As %ZEN.Datatype.string;

Current property.

currCaption​

Property currCaption As %ZEN.Datatype.string;

Current caption.

XDatas​

Style​

XData Style

contentPane​

XData contentPane [ XMLNamespace = "http://www.intersystems.com/zen" ]

This XML defines the contents of the contents pane for this page.

Methods​

%OnGetTitle​

Method %OnGetTitle() As %String

Get the (localized) title string for the page.

%OnGetPageName​

Method %OnGetPageName() As %String

Get the name for the page.

%OnGetProductName​

Method %OnGetProductName() As %String

Get the product name for the page.

OnGetRibbonInfo​

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.

OnDrawRibbon​

Method OnDrawRibbon() As %Status

Draw additional stuff in the ribbon bar

DrawCubeName​

Method DrawCubeName(pSeed As %String) As %Status

Draw cube name above member tree.

changeSubjectArea​

ClientMethod changeSubjectArea() [ Language = javascript ]

Launch the subject area finder dialog.

onPopupAction​

ClientMethod onPopupAction(popupName, action, value) [ Language = javascript ]

This client event is fired when a popup page launched from this page fires an action.

GetDimensionInfo​

ClassMethod GetDimensionInfo(pRoot As %String, Output pTree, ByRef pParms) As %Status

Provide contents of the dimension tree.

Method %GetLocatorLinks(Output pLink) As %Status

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)

onlayoutHandler​

ClientMethod onlayoutHandler(load) [ Language = javascript ]

Adjust sizes of components on the page.

adjustSizes​

ClientMethod adjustSizes() [ Language = javascript ]

Adjust sizes of components on the page.

%OnAfterCreatePage​

Method %OnAfterCreatePage() As %Status

This class method callback is called just before the server-side page object is created.

contextChange​

ClientMethod contextChange(ctx) [ Language = javascript ]

User has selected a new context.

treeChange​

ClientMethod treeChange(tree) [ Language = javascript ]

User has selected a new element in the tree control.

ParseValue​

ClassMethod ParseValue(pCube As %String, pContext As %String, pValue As %String) As %String [ ZenMethod ]

Pull apart the given member spec.

deleteCaption​

ClientMethod deleteCaption() [ Language = javascript ]

Delete the current caption.

DeleteItem​

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.

saveCaption​

ClientMethod saveCaption() [ Language = javascript ]

Save the current caption.

SaveItem​

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.