Mobile API Reference  MicroStrategy 2019
Commander Class Reference

#import <Commander.h>

Inheritance diagram for Commander:

Instance Methods

(DSSCMacroManipulation *) - getMacroManipulationWithResetToFirstPanelCommand:
 
(void) - notifyPanelStackResetToFirstPanel:
 
(void) - findAllPanelStackTargets:withOutputs:
 
(void) - findFirstPanelStackTargets:withOutputs:
 
(BOOL- SynchWithSelectorFromPanelStack:withIndex:
 
(BOOL- isDockedPanelStackSelector:
 
(void) - executeCommitTransactionWithTargetKeys:
 
(void) - setDocInstance:
 
(DSSDocumentInstance *) - getDocInstance
 
(void) - setDocContext:
 
(MSIDocumentContext *) - getDocContext
 
(NSArray *) - getPaletteColors
 
(void) - registerViewer:withNode:
 
(void) - registerViewer:forNodeKey:
 
(void) - unregisterViewer:
 
(void) - unregisterViewersWithNodeKey:
 
(void *) - getCommandByType:
 
(std::vector< void * >) - getAvailableCommandTypes:
 
(int) - executeCommands:
 
(int) - executeCommands:asyncExec:
 
(int) - executeCommands:ShowWaitView:
 
(int) - executeCommands:showWaitViewOnView:
 
(DSSBaseElementProxy *) - getReplacedElement:
 
(MapNodeKeyToViewers *) - getMapNodeKeyToViewers
 
(MapNodeKeyToMasterViewers *) - getMapNodeKeyToMasterViewers
 
(void) - updatePreviewImages:
 
(void) - generatePreviewImage
 
(void) - setRootViewContainer:
 
(UIView *) - getRootViewContainer
 
(void) - setRWDDashBoardView:
 
(UIView *) - getRWDDashBoardView
 
(void) - registerMasterView:forNodeKey:
 
(void) - unregisterMasterViewer:
 
(void) - hideAllInfoWindows:
 
(void) - getImagesFromIServer:forTimeStamp:forAsync:
 
(void) - setDisplayMode:
 
(int) - getDisplayMode
 
(BOOL- isMultiSelectionMode
 
(void) - afterManipulation:
 
(void) - beginReplayManipulation
 
(BOOL- replayManipulations:WithData:WithFlags:
 
(BOOL- replayManipulation:WithData:WithFlags:
 
(void) - replayDrillManipulation:WithData:
 
(void) - endReplayManipulation:
 
(void) - executeLinkDrill:
 
(BOOL- validateCacheExecuteLinkDrill:
 
(BOOL- validateCacheHandleLinkDrill:
 
(void) - handleLinkDrill:
 
(void) - handleLinkDrill:withContext:
 
(void) - handlePDF:
 
(void) - handleEPUB:
 
(void) - handleEPUB:withSender:
 
(void) - handleActionSheet:
 
(void) - handleURLSelection:
 
(NSString *) - getClientManipulations
 
(void) - clearClientManipulations
 
(NSString *) - getSelectedElementOfAttribute:
 
(void) - enableInteraction:
 
(void) - getEmptyGridDisplay:display:
 
(void) - afterBinaryApplied:
 
(BOOL- isDuringBackward
 
(BOOL- isDisabledforShowPrompt
 
(void) - setSavedPopoverContext:
 
(BOOL- hasNextPage
 
(BOOL- hasPreviousPage
 
(BOOL- goToNextPage
 
(BOOL- goToPreviousPage
 
(BOOL- isNGBSelectionsInited
 
(void) - initNGBSelections:
 
(BOOL- needReInitNGBSelections
 
(void) - reinitNGBSelections
 
(void) - clearNGBSelectionsAllFields
 
(void) - getCurrentPageIndex:totalPageCount:
 
(void) - updateNGBSelectionAfterRotation
 
(BOOL- isLeafNGBNode:
 
(int) - getNGBFirstRowIndexInCurrentPage
 
(void) - setContentScaleFactorOnDemandToViews:rootView:
 
(void) - setContentScaleFactorOnDemandToViews:rootView:informView:
 
(void) - restoreZoomForBackOperation
 
(void) - zoomDashboardToScale:
 
(void) - requestMissingBinaryBlock:
 
(BOOL- requestLayoutData:withHandler:withSelector:
 
(void) - showWaitViewOnTop
 
(void) - dismissWaitViewOnTop
 
(void) - dataModelCreationFailed
 
(void) - hideMasterPanel:
 
(void) - showMasterPanel
 
(void) - restoreDetailedTransactionModel:
 
(void) - restoreDetailedTransactionArray:
 
(NSArray *) - getDetailedTransactionData
 
(GridGraphViewer *) - getGridGraphViewerForReport
 
(void) - hideRightNavigationBarButtons
 
(void) - showRightNavigationBarButtons
 
(void) - saveWidgetStateWithObject:forKey:
 
(id) - loadWidgetStateForKey:
 
(void) - saveWidgetState:forKey:
 
(id) - loadWidgetState:
 
(CarryOverSelectionsSet *) - carryOverSelections
 
(CarryOverSelectionsSet *) - carryOverSelectionsWithMode:withPromptMode:currentPrompt:
 
(BOOL- replayCarryOverSelections:refreshUI:
 
(id) - replayCarryOverPrompts:withPromptQuestionXML:withPrompts:
 
(void) - photoUploadImageChange:nodeKey:imgPath:
 
(void) - photoUploadImageChange:nodeKey:imgPath:shouldReplacePreImage:
 
(void) - photoUploadImageChange:imgPath:
 
(void) - photoUploadImageChange:imgPath:shouldReplacePreImage:
 
(DSSRWIterator *) - getDSSRWIteratorForTransactionReport:
 
(void) - refreshInstanceWithData:
 
(std::vector< DSSRWSectionNode * >) - getPanelNodeFromPanelSelectionURLHelper:
 
(BOOL- checkForTransactionUpdate
 
(NSInteger) - chooseDocumentViewForInterfaceOrientation:
 
(BOOL- shouldCancelRendering
 
(NSUInteger) - getNumberOfDocumentViews
 
(void) - handleRenderFinishTime:
 
(CGRect) - updateRootViewerContainerFrame:
 
(CGFloat) - getHeaderSectionYOffset
 
(double) - getDockedHeaderHeight
 
(double) - getDockedFooterHeight
 
(CGFloat) - getCalGroupbyHeight
 
(UIView *) - checkIfInDockedSection:
 
(BOOL- isViewerDocked:
 
(MapNameToNodeKey *) - getMapNameToNodeKey
 
(void) - disableIPhoneLayoutBar:
 
(NSArray *) - getAllDataSetIDs
 
(NSDictionary *) - getDatasetPromptAnswers
 
(NSString *) - getCurrentVisualizationContentPanelStackKey
 
(NSString *) - getVisualizationContentPanelStackKeyForLayout:
 
(void) - setVisualizationContentPanelStackKey:forLayout:
 
(void) - removeVisualizationContentPanelStackKeyForLayout:
 
(NSString *) - getCurrentLayoutKey
 
(NSArray *) - getAllLayoutNames
 
(NSArray *) - getAllLayoutKeys
 
(NSString *) - getCurrentLayoutName
 
(BOOL- isFullScreen
 
(BOOL- hasNavigationTabBar
 
(DocumentThemeHelper *) - documentThemeHelperWithComponentKey:
 
(NSData *) - getViewersStatus
 
(int) - replayViewersStatus:
 
(NSData *) - getSavedViewerStatus:
 
(void) - increaseWidgetCount:
 
(void) - decreaseWidgetCount:
 
(NSString *) - documentName
 
(void) - viewEvaluationFinish
 
(NSInteger) - getColorByItemIndexByColorByString:
 
(CATransform3D) - getRescaleTransformForIPhone6:isLandscape:isFullscreenDoc:extraOccupiedHeight:
 
(NSArray *) - getViewerChangedListAfterManipulation
 
(BOOL- isExporting
 
(void) - handleWillQuitExport:
 
(bool) - shouldDismissIW:withURLHelper:
 
(void) - saveAsVIDocument:andDocName:andDocDesc:andSFlag:
 
(void) - createNewFolder:andFolderName:andFolderDesc:
 
(void) - handleBrushingHighlightForVI:
 

Protected Attributes

DSSDocumentInstancedocInstance
 
MSIDocumentContext * docContext
 
id< RWDDashboardDelegate > __weak delegate
 
UIView *__weak mRootViewContainer
 
UIView *__weak mRWDDashBoardView
 
BOOL isInPortraitMode
 
CommandasyncCommand
 
DrillXMLCommandParameters * drillXMLCommandParams
 
int drillType
 
BOOL waitForPreviousManipulation
 
ManipulationType previousManipulationType
 
MSIURLHelperurlHelper
 
PopoverContextpopoverContext
 
UIImage *__weak mpDefaultFailImage
 
short vizLevel
 
NGBSelections mNGBSelections
 
GridGraphViewer *__weak mpGridGraphViewer
 
NSMutableDictionary * mpWidgetState
 
NSInteger mCurrentDocumentView
 
LayoutManagerViewer *__weak mLayoutManagerViewer
 
LayoutManagerController *__weak mLayoutManagerController
 
bool mUseNewWorkflow
 
DocumentManipulation * documentManipulation
 
ManipulationContext * manipulationContext
 
UIView * currentView
 
BOOL duringNormalManipulation
 
TransactionSubmission * transactionSubmission
 
BOOL mIsNGBNeedRestored
 
BOOL mApplyGroupByToAllLayouts
 
NSMutableDictionary * mpViewerStatusDict
 

Properties

id< RWDDashboardDelegatedelegate
 
NSString * baseURL
 
int webserverType
 
BOOL enableGraphTooltips
 
CGFloat groupbyHeight
 
CGRect frameForView
 
short layoutBarStyle
 
short layoutBarPosition
 
bool enableZoomByPinchOrDoubleTap
 
UIView * groupbyViewer
 
BOOL runAsReport
 
BOOL forceUpdateSubviews
 
BOOL hasLayoutBarPortrait
 
BOOL isReport
 
UIImage * mpDefaultFailImage
 
BOOL isPostOrion
 
BOOL disableGraphAnimation
 
ViewerDataModellayoutContainerViewerModel
 
BOOL containWidget
 
BOOL skipAddNGBSection
 
BOOL firstNGBRow
 
BOOL lastNGBRow
 
BOOL hasNGBAll
 
NGBAllBehaviorType NGBAllBehavior
 
BOOL isAnyCommandRunning
 
BOOL cancelInfoWindowPopping
 
bool isScrollingOrZooming
 
BOOL isVIDocument
 
BOOL showFilterPanel
 
ThemeType mThemeType
 
BOOL isHTML5VIDocument
 
LayoutManagerViewer * layoutManagerViewer
 
LayoutManagerController * layoutManagerController
 
BOOL inSDKMode
 
BOOL isViewFitWidth
 
CGFloat sdkScaleRatio
 
BOOL inPreviewGeneration
 
BOOL previewCancelled
 
BOOL updatePreviewInMain
 
UIView * dockedHeaderView
 
UIView * dockedFooterView
 
BOOL mRenderingHeader
 
BOOL mRenderingFooter
 
CGFloat layoutWidth
 
BOOL inGBA
 
bool mEnableCopyForText
 
BOOL duringRWDDashboardViewFadeInAnimation
 
UIView * responderSelectableTextViewer
 
LinkDrillParameters * linkdrillParam
 
BOOL isTableObjectNode
 
BOOL isVIDocumentChanged
 
DocumentRenderer * documentRenderer
 
CGFloat documentScaleRatio
 
CGFloat documentScaleRatioVertical
 
NSMutableSet * widgetSet
 
BOOL hasWidget
 
CommandVectorWrapperdelayedCommands
 
BOOL needRescaleForiPhone6
 
BOOL applyGroupByToAllLayouts
 
BOOL allowOfflineSubmit
 
BOOL submitInOrder
 
PopoverContextsavedPopoverContext
 
NSInteger currentDocumentView
 

Method Documentation

◆ afterBinaryApplied:()

- (void) afterBinaryApplied: (BOOL iSuccess

◆ afterManipulation:()

- (void) afterManipulation: (NSValue *)  iValue

◆ beginReplayManipulation()

- (void) beginReplayManipulation

◆ carryOverSelections()

- (CarryOverSelectionsSet*) carryOverSelections

◆ carryOverSelectionsWithMode:withPromptMode:currentPrompt:()

- (CarryOverSelectionsSet*) carryOverSelectionsWithMode: (CarryOverSelectedMode mode
withPromptMode: (BOOL promptMode
currentPrompt: (NSString *)  currentPrompt 

◆ checkForTransactionUpdate()

- (BOOL) checkForTransactionUpdate

◆ checkIfInDockedSection:()

- (UIView *) checkIfInDockedSection: (UIView *)  view

◆ chooseDocumentViewForInterfaceOrientation:()

- (NSInteger) chooseDocumentViewForInterfaceOrientation: (UIInterfaceOrientation)  interfaceOrientation

◆ clearClientManipulations()

- (void) clearClientManipulations

◆ clearNGBSelectionsAllFields()

- (void) clearNGBSelectionsAllFields

Clear NGB setting inside Commander.

◆ createNewFolder:andFolderName:andFolderDesc:()

- (void) createNewFolder: (NSString *)  parentFolderID
andFolderName: (NSString *)  folderName
andFolderDesc: (NSString *)  folderDescription 

Provided by category Commander(MOBILE_VI).

◆ dataModelCreationFailed()

- (void) dataModelCreationFailed

◆ decreaseWidgetCount:()

- (void) decreaseWidgetCount: (id)  viewer

◆ disableIPhoneLayoutBar:()

- (void) disableIPhoneLayoutBar: (BOOL disable

◆ dismissWaitViewOnTop()

- (void) dismissWaitViewOnTop

◆ documentName()

- (NSString*) documentName

◆ documentThemeHelperWithComponentKey:()

- (DocumentThemeHelper*) documentThemeHelperWithComponentKey: (NSString *)  componnetKey

◆ enableInteraction:()

- (void) enableInteraction: (BOOL enabled

◆ endReplayManipulation:()

- (void) endReplayManipulation: (BOOL needRefresh

◆ executeCommands:()

- (int) executeCommands: (const std::vector< Command * > &)  iCommands

◆ executeCommands:asyncExec:()

- (int) executeCommands: (const std::vector< Command * > &)  iCommands
asyncExec: (BOOL async 

◆ executeCommands:ShowWaitView:()

- (int) executeCommands: (const std::vector< Command * > &)  iCommands
ShowWaitView: (BOOL showWaitView 

◆ executeCommands:showWaitViewOnView:()

- (int) executeCommands: (const std::vector< Command * > &)  iCommands
showWaitViewOnView: (UIView *)  view 

◆ executeCommitTransactionWithTargetKeys:()

- (void) executeCommitTransactionWithTargetKeys: (NSArray *)  targetKeys

◆ executeLinkDrill:()

- (void) executeLinkDrill: (LinkDrillParameters *)  linkDrillParams

◆ findAllPanelStackTargets:withOutputs:()

- (void) findAllPanelStackTargets: (DSSRWControl *)  ipRWControl
withOutputs: (std::vector< DSSRWSectionNode * > &)  vTargetNodes 

Find all the panel stack targets for a given control node. Added by yzhi If there are nested panel stacks, all the panel stack nodes nested inside are returned.

Parameters
ipRWControla control node
vTargetNodesarray of target panel stack nodes

◆ findFirstPanelStackTargets:withOutputs:()

- (void) findFirstPanelStackTargets: (DSSRWControl *)  ipRWControl
withOutputs: (std::vector< DSSRWSectionNode * > &)  vTargetNodes 

Find the first panel stack targets for a given control node. Added by njiang If there are nested panel stacks, all the panel stack nodes nested inside are returned.

Parameters
ipRWControla control node
vTargetNodesarray of target panel stack nodes

◆ generatePreviewImage()

- (void) generatePreviewImage

◆ getAllDataSetIDs()

- (NSArray*) getAllDataSetIDs

◆ getAllLayoutKeys()

- (NSArray *) getAllLayoutKeys

◆ getAllLayoutNames()

- (NSArray *) getAllLayoutNames

◆ getAvailableCommandTypes:()

- (vector<void*>) Commander: (void *)  iCellHandle

◆ getCalGroupbyHeight()

- (CGFloat) getCalGroupbyHeight

◆ getClientManipulations()

- (NSString*) getClientManipulations

◆ getColorByItemIndexByColorByString:()

- (NSInteger) getColorByItemIndexByColorByString: (NSString *)  colorByItemString

◆ getCommandByType:()

- (void*) getCommandByType: (int)  iType

◆ getCurrentLayoutKey()

- (NSString*) getCurrentLayoutKey

This method can get current layout even it is not a VI document, and an exception is pre-orion document.

◆ getCurrentLayoutName()

- (NSString*) getCurrentLayoutName

◆ getCurrentPageIndex:totalPageCount:()

- (void) getCurrentPageIndex: (int &)  iCurrentPageIndex
totalPageCount: (int &)  iTotalPagesCount 

Calculate the current page index.

◆ getCurrentVisualizationContentPanelStackKey()

- (NSString*) getCurrentVisualizationContentPanelStackKey

Get the visualziationContentPanelStackKey for current layout. This panelstack is the root of visualization zone (and page-by zone, according to lcao). Use [NSString cStringUsingEncoding:] if you need c string or std::string.

◆ getDatasetPromptAnswers()

- (NSDictionary*) getDatasetPromptAnswers

◆ getDetailedTransactionData()

- (NSArray*) getDetailedTransactionData

◆ getDisplayMode()

- (int) getDisplayMode

◆ getDocContext()

- (MSIDocumentContext *) getDocContext

◆ getDocInstance()

- (DSSDocumentInstance*) getDocInstance

◆ getDockedFooterHeight()

- (double) getDockedFooterHeight

◆ getDockedHeaderHeight()

- (double) getDockedHeaderHeight

◆ getDSSRWIteratorForTransactionReport:()

- (DSSRWIterator*) getDSSRWIteratorForTransactionReport: (NSString *)  transactionReportID

Returns DSSRWIterator mapped to transactionReport

Parameters
transactionReportIDtransaction report's ID
Returns
DSSRWIterator* DSSRWIterator mapped to transaction report

◆ getEmptyGridDisplay:display:()

- (void) getEmptyGridDisplay: (NSString **)  emptyMessage
display: (BOOL *)  displayEmptyMsg 

◆ getGridGraphViewerForReport()

- (GridGraphViewer*) getGridGraphViewerForReport

◆ getHeaderSectionYOffset()

- (CGFloat) getHeaderSectionYOffset

◆ getImagesFromIServer:forTimeStamp:forAsync:()

- (void) getImagesFromIServer: (NSArray *)  iImagesArray
forTimeStamp: (NSArray *)  iImagesTimeStamp
forAsync: (BOOL ibAsync 

◆ getMacroManipulationWithResetToFirstPanelCommand:()

- (DSSCMacroManipulation *) getMacroManipulationWithResetToFirstPanelCommand: (const std::string &)  irSelectorKey

Generate a MacroManipulation with ResetToFirstPanel command added, if any.

Parameters
irSelectorKeythe node key of the selector whose target is a panel stack.
Returns
DSSCMacroManipulation* if there is any ResetToFirstPanel command, otherwise NULL.

◆ getMapNameToNodeKey()

- (MapNameToNodeKey*) getMapNameToNodeKey

◆ getMapNodeKeyToMasterViewers()

- (MapNodeKeyToMasterViewers*) getMapNodeKeyToMasterViewers

◆ getMapNodeKeyToViewers()

- (MapNodeKeyToViewers*) getMapNodeKeyToViewers

◆ getNGBFirstRowIndexInCurrentPage()

- (int) getNGBFirstRowIndexInCurrentPage

Get the first row indiex in the current page.

◆ getNumberOfDocumentViews()

- (NSUInteger) getNumberOfDocumentViews

Get the number of document views. 03/07, 2013 yzeng add.

◆ getPaletteColors()

- (NSArray*) getPaletteColors

◆ getPanelNodeFromPanelSelectionURLHelper:()

- (vector<DSSRWSectionNode*>) Commander: (MSIURLHelper *)  iUrlHelper

◆ getReplacedElement:()

- (DSSBaseElementProxy*) getReplacedElement: (std::string)  iNodeKey

◆ getRescaleTransformForIPhone6:isLandscape:isFullscreenDoc:extraOccupiedHeight:()

- (CATransform3D) getRescaleTransformForIPhone6: (CGFloat)  originHeight
isLandscape: (BOOL isLandscape
isFullscreenDoc: (BOOL isFullscreen
extraOccupiedHeight: (CGFloat)  extraOccupiedHeight 

Get the transform for auto fitting iPhone 5 view for iPhone 6/6+ aspect-ratio devices, TQMS 977109

Parameters
originHeightthe oritianl height of content
isLandscapewhether the device is landscape
isFullscreenif YES, we should consider that the navigation bar is not existing
extraOccupiedHeightwe may need to consider the height occupied by other things like the groupby bar

◆ getRootViewContainer()

- (UIView*) getRootViewContainer

◆ getRWDDashBoardView()

- (UIView*) getRWDDashBoardView

◆ getSavedViewerStatus:()

- (NSData*) getSavedViewerStatus: (NSString *)  iViewerID

Get the specific Viewer's status data, whose ID = iViewerID.

◆ getSelectedElementOfAttribute:()

- (NSString*) getSelectedElementOfAttribute: (NSString *)  attributeId

◆ getViewerChangedListAfterManipulation()

- (NSArray*) getViewerChangedListAfterManipulation

This function will return the change list, the content is a list of UIView

◆ getViewersStatus()

- (NSData*) getViewersStatus

Collect all the views status that response to [IViewer getViewerStatus].

◆ getVisualizationContentPanelStackKeyForLayout:()

- (NSString*) getVisualizationContentPanelStackKeyForLayout: (NSString *)  iLayoutKey

Get the visualziationContentPanelStackKey for given layout.

◆ goToNextPage()

- (BOOL) goToNextPage

Change NGB page to the next one. Called in [LayoutContainerViewer - (void)handleEvent].

◆ goToPreviousPage()

- (BOOL) goToPreviousPage

Change NGB page to the previous one. Called in [LayoutContainerViewer - (void)handleEvent].

◆ handleActionSheet:()

- (void) handleActionSheet: (MSIURLHelper *)  urlHelper

◆ handleBrushingHighlightForVI:()

- (void) handleBrushingHighlightForVI: (BrushingHighlightData *)  highlightData

This method helps handling brushing highlight event in vi documents

Provided by category Commander(MOBILE_VI).

◆ handleEPUB:()

- (void) handleEPUB: (MSIURLHelper *)  _urlHelper

◆ handleEPUB:withSender:()

- (void) handleEPUB: (MSIURLHelper *)  _urlHelper
withSender: (UIView *)  iView 

◆ handleLinkDrill:()

- (void) handleLinkDrill: (MSIURLHelper *)  urlHelper

◆ handleLinkDrill:withContext:()

- (void) handleLinkDrill: (MSIURLHelper *)  urlHelper
withContext: (PopoverContext *)  iContext 

◆ handlePDF:()

- (void) handlePDF: (MSIURLHelper *)  urlHelper

◆ handleRenderFinishTime:()

- (void) handleRenderFinishTime: (NSDate *)  date

◆ handleURLSelection:()

- (void) handleURLSelection: (MSIURLHelper *)  iUrlHelper

◆ handleWillQuitExport:()

- (void) handleWillQuitExport: (void(^)())  handler

◆ hasNavigationTabBar()

- (BOOL) hasNavigationTabBar

◆ hasNextPage()

- (BOOL) hasNextPage

Used to judge whether have next page for NGB section.

◆ hasPreviousPage()

- (BOOL) hasPreviousPage

Used to judge whether have previous page for NGB section.

◆ hideAllInfoWindows:()

- (void) hideAllInfoWindows: (BOOL animated

◆ hideMasterPanel:()

- (void) hideMasterPanel: (BOOL disable

◆ hideRightNavigationBarButtons()

- (void) hideRightNavigationBarButtons

◆ increaseWidgetCount:()

- (void) increaseWidgetCount: (id)  viewer

◆ initNGBSelections:()

- (void) initNGBSelections: (DSSRWSectionIterator *)  ipIterator

Used to init NGB setting. It is called in DocumentIterator.

◆ isDisabledforShowPrompt()

- (BOOL) isDisabledforShowPrompt

◆ isDockedPanelStackSelector:()

- (BOOL) isDockedPanelStackSelector: (NodeAndControls *)  lControl

Check whether the panel stack selector is docked. Imported from PanelStackViewer. Added by yzhi.

Parameters
lControla given control node

◆ isDuringBackward()

- (BOOL) isDuringBackward

◆ isExporting()

- (BOOL) isExporting

◆ isFullScreen()

- (BOOL) isFullScreen

◆ isLeafNGBNode:()

- (BOOL) isLeafNGBNode: (DSSRWNode *)  ipRWNode

Judge whether a node is ngb leaf node.

◆ isMultiSelectionMode()

- (BOOL) isMultiSelectionMode

◆ isNGBSelectionsInited()

- (BOOL) isNGBSelectionsInited

Used to judge whether NGB is stored in Commander.

◆ isViewerDocked:()

- (BOOL) isViewerDocked: (UIView *)  view

◆ loadWidgetState:()

- (id) loadWidgetState: (id)  key

◆ loadWidgetStateForKey:()

- (id) loadWidgetStateForKey: (id)  key

◆ needReInitNGBSelections()

- (BOOL) needReInitNGBSelections

Used to judge whether NGB need to reinit, e.g., change sub NGB, it need to reinit NGB setting.

◆ notifyPanelStackResetToFirstPanel:()

- (void) notifyPanelStackResetToFirstPanel: (const std::string &)  selectorKey

notify the panel stack(s) targeted by a given selector to reset to first panel. Added by yzhi. Usually use NSNotification (observer pattern) to notify the panel stack viewers. However, if the panel stack viewer does not exist, DSSCManipulationSetCurrentPanel in commander will be executed.

Parameters
selectorKeythe node key of selector

◆ photoUploadImageChange:imgPath:()

- (void) photoUploadImageChange: (NSString *)  ipNodeKey
imgPath: (NSString *)  ipImgPath 

◆ photoUploadImageChange:imgPath:shouldReplacePreImage:()

- (void) photoUploadImageChange: (NSString *)  ipNodeKey
imgPath: (NSString *)  ipImgPath
shouldReplacePreImage: (BOOL replace 

◆ photoUploadImageChange:nodeKey:imgPath:()

- (void) photoUploadImageChange: (const std::vector< Command * > &)  iCommands
nodeKey: (NSString *)  ipNodeKey
imgPath: (NSString *)  ipImgPath 

◆ photoUploadImageChange:nodeKey:imgPath:shouldReplacePreImage:()

- (void) photoUploadImageChange: (const std::vector< Command * > &)  iCommands
nodeKey: (NSString *)  ipNodeKey
imgPath: (NSString *)  ipImgPath
shouldReplacePreImage: (BOOL replace 

◆ refreshInstanceWithData:()

- (void) refreshInstanceWithData: (NSData *)  newData

◆ registerMasterView:forNodeKey:()

- (void) registerMasterView: (id< IViewer >)  iViewer
forNodeKey: (std::string)  iNodeKey 

◆ registerViewer:forNodeKey:()

- (void) registerViewer: (id< IViewer >)  iViewer
forNodeKey: (std::string)  iNodeKey 

◆ registerViewer:withNode:()

- (void) registerViewer: (id< IViewer >)  iViewer
withNode: (DSSRWNode *)  iNode 

◆ reinitNGBSelections()

- (void) reinitNGBSelections

Reinit NGB setting inside Commander.

◆ removeVisualizationContentPanelStackKeyForLayout:()

- (void) removeVisualizationContentPanelStackKeyForLayout: (NSString *)  iLayoutKey

Remove the visualziationContentPanelStackKey for given layout.

◆ replayCarryOverPrompts:withPromptQuestionXML:withPrompts:()

- (id) replayCarryOverPrompts: (CarryOverSelectionsSet *)  selections
withPromptQuestionXML: (NSData *)  promptQestion
withPrompts: (id)  data 

◆ replayCarryOverSelections:refreshUI:()

- (BOOL) replayCarryOverSelections: (CarryOverSelectionsSet *)  selections
refreshUI: (BOOL refresh 

replay manipulations in the carry over selection

Parameters
selectionscarry over selections set
refreshIs it necessary to refresh the UI after replay action
Returns
Whether the replay will need to send network request

◆ replayDrillManipulation:WithData:()

- (void) replayDrillManipulation: (DrillXMLCommandParameters *)  parameters
WithData: (NSData *)  newData 

◆ replayManipulation:WithData:WithFlags:()

- (BOOL) replayManipulation: (NSString *)  events
WithData: (NSData *)  newData
WithFlags: (unsigned int)  flags 

◆ replayManipulations:WithData:WithFlags:()

- (BOOL) replayManipulations: (NSArray *)  events
WithData: (NSData *)  newData
WithFlags: (unsigned int)  flags 

◆ replayViewersStatus:()

- (int) replayViewersStatus: (NSData *)  iData

Restore all the views data stored as before.

Returns
1, success 0, iData is nil -1, iData format is wrong,

◆ requestLayoutData:withHandler:withSelector:()

- (BOOL) requestLayoutData: (DSSRWNode *)  iRWNode
withHandler: (id< BinaryRetrievalHandler >)  iHandler
withSelector: (SEL)  callbackFunction 

◆ requestMissingBinaryBlock:()

- (void) requestMissingBinaryBlock: (NSString *)  iLayoutKey

◆ restoreDetailedTransactionArray:()

- (void) restoreDetailedTransactionArray: (NSArray *)  iTransactionDetails

◆ restoreDetailedTransactionModel:()

- (void) restoreDetailedTransactionModel: (TransactionParameters *)  iTransactionParameters

◆ restoreZoomForBackOperation()

- (void) restoreZoomForBackOperation

◆ saveAsVIDocument:andDocName:andDocDesc:andSFlag:()

- (void) saveAsVIDocument: (NSString *)  folderID
andDocName: (NSString *)  docName
andDocDesc: (NSString *)  docDescription
andSFlag: (EnumDSSXMLDocSaveAsFlags flag 

Provided by category Commander(MOBILE_VI).

◆ saveWidgetState:forKey:()

- (void) saveWidgetState: (id)  obj
forKey: (id)  key 

◆ saveWidgetStateWithObject:forKey:()

- (void) saveWidgetStateWithObject: (id)  obj
forKey: (id)  key 

◆ setContentScaleFactorOnDemandToViews:rootView:()

- (void) setContentScaleFactorOnDemandToViews: (UIView *)  iView
rootView: (UIView *)  iRootView 

◆ setContentScaleFactorOnDemandToViews:rootView:informView:()

- (void) setContentScaleFactorOnDemandToViews: (UIView *)  iView
rootView: (UIView *)  iRootView
informView: (BOOL inform 

◆ setDisplayMode:()

- (void) setDisplayMode: (int)  iDispalyMode

◆ setDocContext:()

- (void) setDocContext: (MSIDocumentContext *)  iDocContext

◆ setDocInstance:()

- (void) setDocInstance: (DSSDocumentInstance *)  instance

◆ setRootViewContainer:()

- (void) setRootViewContainer: (UIView *)  iRootViewContainer

◆ setRWDDashBoardView:()

- (void) setRWDDashBoardView: (UIView *)  RWDDashBoardView

◆ setSavedPopoverContext:()

- (void) setSavedPopoverContext: (PopoverContext *)  iContext

◆ setVisualizationContentPanelStackKey:forLayout:()

- (void) setVisualizationContentPanelStackKey: (NSString *)  iVIContentPanelStackKey
forLayout: (NSString *)  iLayoutKey 

Set the visualziationContentPanelStackKey for given layout.

◆ shouldCancelRendering()

- (BOOL) shouldCancelRendering

◆ shouldDismissIW:withURLHelper:()

- (bool) shouldDismissIW: (InfoWindowContainerViewer *)  infoWindow
withURLHelper: (MSIURLHelper *)  urlHelper 

◆ showMasterPanel()

- (void) showMasterPanel

◆ showRightNavigationBarButtons()

- (void) showRightNavigationBarButtons

◆ showWaitViewOnTop()

- (void) showWaitViewOnTop

◆ SynchWithSelectorFromPanelStack:withIndex:()

- (BOOL) SynchWithSelectorFromPanelStack: (DSSRWSectionNode *)  ipRWSectionNode
withIndex: (const int)  iIdx 

Synchronize selector(s) with panel stack by a given index. Imported from PanelStackViewer. Added by yzhi.

Parameters
ipRWSectionNodepanel stack node
iIdxthe panel index to synchronize

◆ unregisterMasterViewer:()

- (void) unregisterMasterViewer: (id< IViewer >)  iViewer

◆ unregisterViewer:()

- (void) unregisterViewer: (id< IViewer >)  iViewer

◆ unregisterViewersWithNodeKey:()

- (void) unregisterViewersWithNodeKey: (std::string)  iNodeKey

◆ updateNGBSelectionAfterRotation()

- (void) updateNGBSelectionAfterRotation

Update the NGB setting inside commander. Called in [LayoutContainerViewer - (void)handleEvent].

◆ updatePreviewImages:()

- (void) updatePreviewImages: (NSDictionary *)  images

◆ updateRootViewerContainerFrame:()

- (CGRect) updateRootViewerContainerFrame: (CGRect)  frame

◆ validateCacheExecuteLinkDrill:()

- (BOOL) validateCacheExecuteLinkDrill: (LinkDrillParameters *)  linkDrillParams

◆ validateCacheHandleLinkDrill:()

- (BOOL) validateCacheHandleLinkDrill: (MSIURLHelper *)  urlHelper

◆ viewEvaluationFinish()

- (void) viewEvaluationFinish

◆ zoomDashboardToScale:()

- (void) zoomDashboardToScale: (CGFloat)  iScale

Member Data Documentation

◆ asyncCommand

- (Command*) asyncCommand
protected

◆ currentView

- (UIView*) currentView
protected

◆ delegate

- (id<RWDDashboardDelegate> __weak) delegate
protected

◆ docContext

- (MSIDocumentContext*) docContext
protected

◆ docInstance

- (DSSDocumentInstance*) docInstance
protected

◆ documentManipulation

- (DocumentManipulation*) documentManipulation
protected

◆ drillType

- (int) drillType
protected

◆ drillXMLCommandParams

- (DrillXMLCommandParameters*) drillXMLCommandParams
protected

◆ duringNormalManipulation

- (BOOL) duringNormalManipulation
protected

◆ isInPortraitMode

- (BOOL) isInPortraitMode
protected

◆ manipulationContext

- (ManipulationContext*) manipulationContext
protected

◆ mApplyGroupByToAllLayouts

- (BOOL) mApplyGroupByToAllLayouts
protected

◆ mCurrentDocumentView

- (NSInteger) mCurrentDocumentView
protected

◆ mIsNGBNeedRestored

- (BOOL) mIsNGBNeedRestored
protected

◆ mLayoutManagerController

- (LayoutManagerController* __weak) mLayoutManagerController
protected

◆ mLayoutManagerViewer

- (LayoutManagerViewer* __weak) mLayoutManagerViewer
protected

◆ mNGBSelections

- (NGBSelections) mNGBSelections
protected

◆ mpDefaultFailImage

- (UIImage* __weak) mpDefaultFailImage
protected

◆ mpGridGraphViewer

- (GridGraphViewer* __weak) mpGridGraphViewer
protected

◆ mpViewerStatusDict

- (NSMutableDictionary*) mpViewerStatusDict
protected

◆ mpWidgetState

- (NSMutableDictionary*) mpWidgetState
protected

◆ mRootViewContainer

- (UIView* __weak) mRootViewContainer
protected

◆ mRWDDashBoardView

- (UIView* __weak) mRWDDashBoardView
protected

◆ mUseNewWorkflow

- (bool) mUseNewWorkflow
protected

◆ popoverContext

- (PopoverContext*) popoverContext
protected

◆ previousManipulationType

- (ManipulationType) previousManipulationType
protected

◆ transactionSubmission

- (TransactionSubmission*) transactionSubmission
protected

◆ urlHelper

- (MSIURLHelper*) urlHelper
protected

◆ vizLevel

- (short) vizLevel
protected

◆ waitForPreviousManipulation

- (BOOL) waitForPreviousManipulation
protected

Property Documentation

◆ allowOfflineSubmit

- (BOOL) allowOfflineSubmit
readwritenonatomicassign

◆ applyGroupByToAllLayouts

- (BOOL) applyGroupByToAllLayouts
readnonatomicassign

◆ baseURL

- (NSString *) baseURL
readwritenonatomiccopy

◆ cancelInfoWindowPopping

- (BOOL) cancelInfoWindowPopping
readwritenonatomicassign

◆ containWidget

- (BOOL) containWidget
readwritenonatomicassign

◆ currentDocumentView

- (NSInteger) currentDocumentView
readwritenonatomicassign

◆ delayedCommands

- (CommandVectorWrapper*) delayedCommands
readwritenonatomicstrong

◆ delegate

- (id<RWDDashboardDelegate>) delegate
readwritenonatomicweak

◆ disableGraphAnimation

- (BOOL) disableGraphAnimation
readwritenonatomicassign

◆ dockedFooterView

- (UIView *) dockedFooterView
readwritenonatomicstrong

◆ dockedHeaderView

- (UIView *) dockedHeaderView
readwritenonatomicstrong

◆ documentRenderer

- (DocumentRenderer*) documentRenderer
readwritenonatomicweak

◆ documentScaleRatio

- (CGFloat) documentScaleRatio
readwritenonatomicassign

◆ documentScaleRatioVertical

- (CGFloat) documentScaleRatioVertical
readwritenonatomicassign

◆ duringRWDDashboardViewFadeInAnimation

- (BOOL) duringRWDDashboardViewFadeInAnimation
readwriteatomicassign

◆ enableGraphTooltips

- (BOOL) enableGraphTooltips
readwritenonatomicassign

◆ enableZoomByPinchOrDoubleTap

- (bool) enableZoomByPinchOrDoubleTap
readwritenonatomicassign

◆ firstNGBRow

- (BOOL) firstNGBRow
readnonatomicassign

◆ forceUpdateSubviews

- (BOOL) forceUpdateSubviews
readwritenonatomicassign

◆ frameForView

- (CGRect) frameForView
readwritenonatomicassign

◆ groupbyHeight

- (CGFloat) groupbyHeight
readwritenonatomicassign

◆ groupbyViewer

- (UIView *) groupbyViewer
readwritenonatomicstrong

◆ hasLayoutBarPortrait

- (BOOL) hasLayoutBarPortrait
readwritenonatomicassign

◆ hasNGBAll

- (BOOL) hasNGBAll
readnonatomicassign

◆ hasWidget

- (BOOL) hasWidget
readwritenonatomicassign

◆ inGBA

- (BOOL) inGBA
readwritenonatomicassign

◆ inPreviewGeneration

- (BOOL) inPreviewGeneration
readwritenonatomicassign

◆ inSDKMode

- (BOOL) inSDKMode
readwritenonatomicassign

◆ isAnyCommandRunning

- (BOOL) isAnyCommandRunning
readwritenonatomicassign

◆ isHTML5VIDocument

- (BOOL) isHTML5VIDocument
readwritenonatomicassign

◆ isPostOrion

- (BOOL) isPostOrion
readwritenonatomicassign

◆ isReport

- (BOOL) isReport
readwritenonatomicassign

◆ isScrollingOrZooming

- (bool) isScrollingOrZooming
readwritenonatomicassign

◆ isTableObjectNode

- (BOOL) isTableObjectNode
readwritenonatomicassign

◆ isVIDocument

- (BOOL) isVIDocument
readwritenonatomicassign

◆ isVIDocumentChanged

- (BOOL) isVIDocumentChanged
readwritenonatomicassign

◆ isViewFitWidth

- (BOOL) isViewFitWidth
readwritenonatomicassign

◆ lastNGBRow

- (BOOL) lastNGBRow
readnonatomicassign

◆ layoutBarPosition

- (short) layoutBarPosition
readwritenonatomicassign

◆ layoutBarStyle

- (short) layoutBarStyle
readwritenonatomicassign

◆ layoutContainerViewerModel

- (ViewerDataModel *) layoutContainerViewerModel
readwritenonatomicstrong

◆ layoutManagerController

- (LayoutManagerController*) layoutManagerController
readwritenonatomicweak

◆ layoutManagerViewer

- (LayoutManagerViewer*) layoutManagerViewer
readwritenonatomicweak

◆ layoutWidth

- (CGFloat) layoutWidth
readwritenonatomicassign

◆ linkdrillParam

- (LinkDrillParameters *) linkdrillParam
readwritenonatomicstrong

◆ mEnableCopyForText

- (bool) mEnableCopyForText
readwritenonatomicassign

◆ mpDefaultFailImage

- (UIImage*) mpDefaultFailImage
readwritenonatomicweak

◆ mRenderingFooter

- (BOOL) mRenderingFooter
readwritenonatomicassign

◆ mRenderingHeader

- (BOOL) mRenderingHeader
readwritenonatomicassign

◆ mThemeType

- (ThemeType) mThemeType
readwritenonatomicassign

◆ needRescaleForiPhone6

- (BOOL) needRescaleForiPhone6
readwritenonatomicassign

◆ NGBAllBehavior

- (NGBAllBehaviorType) NGBAllBehavior
readwritenonatomicassign

◆ previewCancelled

- (BOOL) previewCancelled
readwritenonatomicassign

◆ responderSelectableTextViewer

- (UIView*) responderSelectableTextViewer
readwritenonatomicweak

◆ runAsReport

- (BOOL) runAsReport
readwritenonatomicassign

◆ savedPopoverContext

- (PopoverContext*) savedPopoverContext
readwritenonatomicstrong

◆ sdkScaleRatio

- (CGFloat) sdkScaleRatio
readwritenonatomicassign

◆ showFilterPanel

- (BOOL) showFilterPanel
readwritenonatomicassign

◆ skipAddNGBSection

- (BOOL) skipAddNGBSection
readwritenonatomicassign

◆ submitInOrder

- (BOOL) submitInOrder
readwritenonatomicassign

◆ updatePreviewInMain

- (BOOL) updatePreviewInMain
readwritenonatomicassign

◆ webserverType

- (int) webserverType
readwritenonatomicassign

◆ widgetSet

- (NSMutableSet*) widgetSet
readwritenonatomicstrong