The DeepSee DashBoard viewer page. More...

Inheritance diagram for DashboardViewer:

[legend]

Collaboration diagram for DashboardViewer:

[legend]

Public Member Functions
_.Library.String	ClearDashboardSettings ()
	Clear settings for the current dashboard.

_.Library.Status	GetDbDefinition (pParms, _.Library.RegisteredObject pObject)
	Get the definition of this dashboard for the JSON provider.

_.Library.String	GetInternalName ()
	Return the internal name of the current document, including the three letter. More...

_.Library.Status	GetOptionList (pParameters, pMetaData, pData)
	Return JSON array of options. More...

_.Library.Status	GetWidgetTypeList (pParameters, pMetaData, pData)
	Return JSON array of widget types. More...

_.Library.String	SaveDashboardSettings (_.Library.String pUser)
	Save settings for the current dashboard.

_.Library.String	SaveWidget (_.Library.String pWidgetKey, _.Library.String pLocalDataSource)
	Change the local datasource for one widget and save it to local settings.

_.Library.Status	SubmitDashboardDef (_.Library.String pCommand, _.ZEN.Auxiliary.jsonProvider pProvider, _.DeepSee.Dashboard.Definition pSubmitObject, _.Library.RegisteredObject pResponseObject)
	Submit handler for the dashboard definition. More...

	actionHandler (widget, dataSource, action)
	This handles any actions that were not handled by the widgets on the dashboard. More...

	addControlDef ()
	Launch the new control wizard.

	addDataPropertyDef ()
	Launch the new data property wizard.

	addThisToFavorites ()
	Add this dashboard to the favorites list.

	addWidgetFromCatalog ()
	Invoke widget catalog dialog.

	chooseSCMenu (menuName, commandName, saveFlags)
	Handle a source control menu selection.

	clearAutosaveState ()
	Remove any autosave state associated with this dashboard – the dashboard. More...

	clearSettings ()
	Clear saved dashboard settings.

	dashboardEventHandler (sourceWidget, which, control, action, target, targetProperty, varType)
	Central handler for control events on this dashboard. More...

	deleteDashboard ()
	Delete this dashboard.

	drillDown (widget, dataSource)
	Execute a drill down for the given widget.

	fetchOptionList (which, spec, properties)
	Fetch the given list of options from the server.

	filterDropDown (ctrl, widgetKey, dataSource)
	Drop down is about to appear for searchBox control.

	getClientModel ()
	Get the jsonProvider object on the client. More...

	getCurrWidget ()
	If there is a selected widget, return it.

	getCurrentExtension ()
	Return the extension used by Studio for the class/object. More...

	getCurrentName ()
	Return the current name of the class/object being modified. More...

	getGridColumns ()
	Number of grid columns in the desktop.

	getGridRows ()
	Number of grid rows in the desktop.

	getSaveAction (force)
	Return the string used as the command when sending JSON content to the server. More...

	getToolbarData ()
	Return json data to drive the toolbar. More...

	getWidgetLayout ()
	Get the current size and position of each widget and place it within the widget. More...

	gotoAnalyzer ()
	Show the analyzer page.

	isReadOnly ()
	Test if this page is in read only mode.

	launchColorChooser ()
	Launch the color chooser.

	mailDashboard ()
	email this dashboard.

	navCloseButtonClick (key)
	Click on close button in navigator.

	navDataArrange (key, swap, final)
	Arrange of data list in navigator.

	navDataChange (key, value, final)
	Change of data value in navigator.

	navExpand ()
	Expand or contract of navigator.

	navGetContentForLevel (level, key, value)
	Return an object describing what to display for this level within the navigator.

	navHeaderButtonClick (key)
	Click on header button in navigator.

	navPopupAction (key, value)
	Popup action in navigator.

	navSelectItem (key, value, which)
	Select of item within the navigator.

	newDashboard ()
	Create a new dashboard.

	newWidget ()
	Invoke the widget wizard dialog to add a new widget to the dashboard.

	onAdjustSizes (load, contentWidth, contentHeight)
	Adjust sizes of content area.

	onPopupAction (popupName, action, value)
	This client event is fired when the a popup page launched from this page fires an action.

	onloadHandler ()
	Add check to ensure that we correctly load documents on the client when source control hooks are in use.

	onlogoutHandler ()
	Ensure that auto-logout is not blocked by onunloadHandler checking for unsaved changes.

	onunloadHandler ()
	This client event, if present, is fired when the page is unloaded. More...

	openDashboard ()
	Launch the dashboard finder.

	recreateHandler (widgetKey)
	Called after a widget is recreated.

	reloadDashboard ()
	Reload the dashboard (show current saved state)

	removeMenuOption (_.Library.String option)
	Helper method to remove a menu option. More...

	runAutosave ()
	Perform an autosave of the current dashboard, filed under the current user.

	saveCopyOfDashboard ()
	Launch the save as dialog.

	saveDashboard (show, autosaveDashboard)
	Launch the save dialog. More...

	saveSettings (user)
	Save the dashboard settings for the current user (save my settings).

	saveWidgetToCatalog ()
	Save the selected widget to the widget catalog.

	saveWidgetToTheme ()
	Save the selected widget styles to the theme catalog.

	setGridColumns (cols)
	Set number of grid columns in the desktop.

	setGridRows (rows)
	Set number of grid rows in the desktop.

	setProperty (property, value, value2)
	Set the value of a named property. More...

	setReadOnly (readOnly)
	Set <property>readOnly</property> to the value of readOnly. More...

	setTitleBarColorAndOpacity ()
	Apply color and opacity to all available widgets.

	showPDFOptions ()
	Launch the pdf options dialog.

	updateWorklistTitle ()
	Update the title for the dashboard.

	widgetSelected (evt, key)
	User has selected a widget on the dashboard.

Public Member Functions inherited from standardPage
_.Library.Status	DrawTitle (_.Library.String pSeed)
	Draw the contents of the title area. More...

_.Library.Status	DrawWorklist1 (_.Library.String pSeed)
	Draw the contents of the worklist 1.

_.Library.Status	DrawWorklist2 (_.Library.String pSeed)
	Draw the contents of the worklist 2.

_.Library.Status	DrawWorklistHeader1 (_.Library.String pSeed)
	Draw the header for worklist 1.

_.Library.Status	DrawWorklistHeader2 (_.Library.String pSeed)
	Draw the the header for worklist 2.

_.Library.Status	DrawWorklistTitle (_.Library.String pSeed)
	Draw the contents of the worklist title area.

_.Library.String	SendItemToTrash (_.Library.String pName)
	Move the given folder item to the trash folder.

	addToFavorites (name)
	Add item to favorites.

	adjustSizes (load)
	Adjust sizes of components on the page.

	getNavigator ()
	Get the navigator component.

	getTitleAreaHeight ()
	Return the height of the title area (titleBar plus locator).

	goHome ()
	Go to the home page.

	gotoAlert (url)
	View the given alert.

	gotoFavorite (url)
	View the given favorite.

	gotoNamespace (url)
	Navigate to a new namespace in the portal.

	logout ()
	End the current session.

	navGetContentForLevel (level, key)
	Return an object describing what to display for this level within the navigator.

	navigate (url)
	Navigate to a new page in the portal.

	onServerMethodError (err, errObject)
	Custom handler for hyperEvent handlers to be (optionally) less. More...

	onlayoutHandler (load)
	Adjust sizes of components on the page.

	reloadPage ()
	Reload this page in an IE-friendly way!

	removeFromAlerts (alertId)
	Remove item from alerts.

	removeFromFavorites (name)
	Remove item from favorites.

	removeFromRecentList (name)
	Remove item from recent list.

	sendAlert ()
	Launch the send alert dialog.

	sendMail (url, title)
	Launch the send email dialog.

	setCompanyCell (content)
	Set the HTML contents of the company logo cell in the title. More...

	setPortalTitleMsg (msg)
	Set the contents of the small message box in the title.

	setWorklistView (id, mode, type)
	Called when user updates or clicks on an icon in a worklist.

	showAbout ()
	Go to the home page.

	showHelp ()
	Show documentation.

	toggleWorklists ()
	Toggle display of work lists.

	updateCompanyCell (load)
	Update the contents of the company cell in the title (if present) to. More...

	updateWorklistType (mode)
	Update the all worklists showing the given type.

Public Member Functions inherited from page
_.Library.Status	DrawJSResources ()
	Local override.

_.Library.Status	GetJSResources (_.Library.String pResources)
	Local override.

	LayoutChildren (_.Library.Integer pTuple)
	Does the actual work of laying out the children of this group. More...

_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local)
	Local override.

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Local override.

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Local override.

Public Member Functions inherited from abstractPage
_.Library.Boolean	DrawFrameSet ()
	If defined, draw out a frameset definition instead of the normal body tags.

_.Library.Status	OnGetJSResources (_.Library.String pResources)
	Pages can implement this callback method in order to define a set of. More...

_.Library.Status	OnNew ()
	Note: This is marked as Final. More...

	cancelPopup ()
	This client method will cancel a popup page (i.e. More...

	correctIELayering (div)
	Correct for an embedded object layering bug that has persisted in IE since the invention. More...

	createComponent (name)
	Client-side method to create a Zen component on the client. More...

	createComponentNS (ns, name, parent, div)
	Client-side method to create a Zen component on the client. More...

	deleteComponent (comp, refresh, sync)
	Client-side method to remove a Zen component from a page on the client. More...

	endModal ()
	End the current modal component; restore previous modal item. More...

	fireOnResizeEvent ()
	Client-side method: fire onresize event for page component.

	fireOnUnloadEvent ()
	Client-side method: fire onunload event for every component that defines one. More...

	firePopupAction (action, value, close)
	This client method will notify the parent window of this popup that. More...

	getComponent (index)
	Client-side method to find component by component index. More...

	getComponentById (id, tuple)
	Client-side method to find a component by user-assigned id value. More...

	getOpener ()
	Helper method to get a reference to the window that launched this window. More...

	gotoPage (url)
	Set the location of the browser to a new url. More...

	launchPopupWindow (url, pageName, features, parms, parent)
	Open a popup window with given url url and page name pageName. More...

	onServerMethodCall (method)
	If implemented, this method is called just. More...

	onServerMethodReturn (method)
	If implemented, this method is called just. More...

	onhandleAutoLogoutWarn ()
	Handle client page modifications while the session is still valid before the page is reloaded. More...

	onkeydownHandler (evt)
	This client event, if present, is fired when a keydown event occurs on the page.

	onkeyupHandler (evt)
	This client event, if present, is fired when a keyup event occurs on the page.

	onoverlayHandler (index)
	This client event, if present, is fired when a component with. More...

	onresizeHandler ()
	This client event, if present, is fired when the page is resized.

	popupActionHandler (parent, name, action, value)
	Internal method. More...

	setComponentId (obj, id)
	Change id of given component.

	setTraceOption (name, flag)
	This client method lets you turn the various client-side. More...

	startModal (component)
	Make the given component modal; That is all events outside of this. More...

Public Member Functions inherited from abstractGroup
	addChild (component, refresh)
	Client-side method. More...

	addChildAfter (component, sibling, refresh)
	Client-side method. More...

	addChildBefore (component, sibling, refresh)
	Client-side method. More...

	childrenMutated ()
	Notification to subclasses that a child has been added or removed. More...

	exposeComponent ()
	This manages the ondisplay event callback handling. More...

	getChildIndex (child)
	Look for the given child object within this group's set of. More...

	onRefreshContents ()
	This client event, if present, is fired when the page is loaded.

	ondisabledHandler ()
	Client-side method that is called when a group's disabled. More...

	removeChild (component)
	Client-side method. More...

	setOverlayMode (mode)
	Set overlay mode for each child of this group.

	setPropertyAll (property, value, value2)
	Apply the given value to the specified property for. More...

Public Member Functions inherited from component
	dragFinishHandler (dragData)
	This is called when a drag operation started within this component. More...

	dragHandler ()
	This is called by the layout manager when a drag-and-drop operation. More...

	dragNotifyHandler (dragData)
	This is called by the layout manager when a drag operation. More...

	dragStartHandler (dragData)
	This is called when a drag operation is started within this component. More...

	dropHandler ()
	This is called by the layout manager when a drag-and-drop operation. More...

	dropStartHandler (dragData)
	This is called when a data drop operation is started within this component. More...

	getEnclosingDiv ()
	Client-side method returns the div element that encloses. More...

_.Library.String	getHidden ()
	Return whether this component is hidden.

	getHintElement ()
	Client-side method returns the HTML element that displays. More...

	getLabelElement ()
	Client-side method returns the HTML element that displays. More...

	onDisplayHandler ()
	This client callback is called from exposeComponent after. More...

	onEndModalHandler (zindex)
	Notification that this component is about to stop being modal.

	onStartModalHandler (zindex)
	Notification that this component is about to become modal. More...

	refreshContents (sync)
	This method, called from a client page, invokes this component's. More...

	setHidden (flag)
	If flag is true, hide this component. More...

	startProgressBar (div)
	Start the display of a progress bar within display. More...

	stopProgressBar ()
	Stop the timer used by the Progress bar.

Public Member Functions inherited from object
_.Library.Status	OnNew (_.Library.RawString initvalue)
	Constructor for Zen objects. More...

	findElement (subid)
	Client-side utility method that finds an HTML element with a. More...

	fireOnUpdateEvent ()
	This is called when an object is updated from the server. More...

_.Library.String	getProperty (property, key)
	Return the value of a named property (i.e. More...

	getSettings (settings)
	Client-side method that returns a list of this component's. More...

	getType ()
	Returns the component type of this object. More...

	invokeSuper (method, args)
	Invoke the superclass method method of the current. More...

	isOfType (type)
	Returns true if this object is of the given component type. More...

	makeId (subid)
	client-side utility method that constructs a component-specific id More...

	onCreate ()
	This client method, if present, is called when this component is. More...

	onDelete ()
	This client method, if present, is called when this component is. More...

	onSerialize ()
	This client event, if present, is fired before a component. More...

	onupdateHandler ()
	This client method, if present, is fired when the object is updated from the server.

	render ()
	This causes a component that draws its contents dynamically. More...

	renderContents ()
	This method, if present, is called when this component. More...

	renderSVG (document, parent)
	This method is only needed for SVG components. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Public Member Functions inherited from Base
_.Library.String	UpdateSCMenus (_.Library.Boolean showMenu)
	Update the _sourceControlMenu Javascript object representing the contents of the source control menus.

	appendServerOutput (data, first)
	Render the server output from source control commands on the client.

	canUserModify (noAlert)
	Helper method to indicate whether the user is allowed to make changes to the. More...

	checkTextControls ()
	Helper method for event sequencing: the onmousedown event for the menu buttons and shapes in the SVG diagram. More...

	chooseSCProject (projectName, isNew)
	The user has selected on of the projects listed in the dropdown.

	clearSCOutput ()
	Clear the source control output on the server and update the content star.

	createSCMenuItem (parentItem, caption, onselect)
	Helper method to create an item in the source control menu.

	createSCProject (projectName)
	Create a new project on the server.

	createSCSubMenu (parentItem, caption)
	Helper method to create a submenu in the source control menu.

_.Library.String	getPageTitle ()
	Get the title string to add to the locator row. More...

	getReadOnlyReason ()
	Callback to get the text of the reason for the current document being loaded as readonly.

	initializeSourceControl ()
	Function to initialize the source control hooks for a page. More...

	initializeTextMonitor ()
	Initialize the text monitor for the page.

	invokeAfterUserAction (input, userContext)
	Client-side coordinator of calls to the AfterUserAction callback in. More...

	invokeSourceControl (action, isFramework)
	Client-side coordinator of calls to the UserAction callback in. More...

	loadDocument ()
	Method to load document from the client and invoke the correct source control hooks.

	onDocumentLoad (when, documentName)
	Callback invoked when a document is being loaded.

	onDocumentLoadComplete ()
	Callback method invoked after we have successfully loaded the current document.

	onDocumentSave (when, documentName)
	Callback invoked when a document is being saved.

	onDocumentSaveComplete (contentModified)
	Callback method invoked after we successfully save the current document.

	reloadDocument ()
	Reload the current document. More...

	saveDocument (force)
	Save the current document using the correct source control hooks.

	setSCProject (newProject)
	Notify the server that a specific project has been chosen.

	showSCMenu ()
	Display the source control menu based on the contents of the _sourceControlMenu data. More...

	showSCOutput ()
	Open a popup to display the current source control output.

	textControlKeyDown (zenControl)
	Key handler to record the value of text fields before the keyboard event is processed. More...

	textControlKeyUp (event, zenControl)
	Key handler to work out whether user keys entered in controls have. More...

	updateDocumentState (alertOnReadOnly)
	Helper method to ensure that the <property>readOnly</property> and. More...

	updateSCIndicator (haveOutput)
	Toggle the display of the star which indicates whether new. More...

Static Public Member Functions
_.Library.Status	GetDimensionInfo (_.Library.String pRoot, pTree, pParms)
	Provide contents of the dimension tree. More...

_.Library.String	SavePivotTable (_.DeepSee.Component.pivotTable pPivot, _.Library.String autoSavePivotName)
	Save the pivot table so we have an autosaved version.

Static Public Member Functions inherited from standardPage
_.Library.Status	GetQuickLinks (pLinks)
	Define any quick links for the page.

Static Public Member Functions inherited from page
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Local override.

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Local override.

Static Public Member Functions inherited from abstractPage
_.Library.Boolean	JavaInstalled ()
	Wrapper method for ZEN.Utils. More...

_.Library.Status	OnPage ()
	Render the contents of this Zen page.

	OnPostHTTP ()
	PostHTTP handler for all Zen pages. More...

_.Library.Status	OnPostHyperEvent ()
	Event handler which is invoked after a hyperevent method is called on this page.

_.Library.Status	OnPreHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked before a hyperevent method is called on all Zen pages. More...

Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Static Public Member Functions inherited from Page
_.Library.Status	ConvertParameter (_.Library.String url, _.Library.String name, _.Library.String value)
	You pass this the <parameter>url</parameter> of the page you are going to and a. More...

_.Library.Binary	Decrypt (_.Library.String data)
	Decrypts the input string using the session.Key value that is unique to. More...

_.Library.String	Encrypt (_.Library.Binary data)
	Encrypts the input string using the session.Key value that is unique to this. More...

_.Library.String	EscapeHTML (in)
	This method converts input HTML text into Escaped HTML text.

_.Library.String	EscapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in input URL string into Escaped URL string. More...

_.Library.String	HyperEventCall (_.Library.String methodName, _.Library.String args, _.Library.Integer type, _.Library.Boolean mobile)
	This method returns the string that needs to be written to the current. More...

_.Library.String	HyperEventHead (_.Library.Boolean iframeOnly, _.Library.Boolean strict, _.Library.Boolean optionalBroker)
	This method returns the string that needs to be written to the current. More...

	Include (_.Library.String url)
	Include another csp page or file in the output at this point. More...

_.Library.String	InsertHiddenField (_.Library.String url, _.Library.String name, _.Library.String value, _.Library.String extra)
	Inserts a '<input type="hidden" name="Name" value="Value">' tag into the current document. More...

_.Library.String	InsertHiddenFields (_.Library.String url, _.Library.String query)
	Return the string containing the hidden form tags. More...

_.Library.Boolean	IsPrivate ()
	Returns 1 if this page is in fact a private page (see <parameter>PRIVATE</parameter>).

_.Library.Status	OnHTTPHeader (_.Library.Boolean OutputBody)
	Event handler for PAGE event: this is invoked in order to More...

	OnPageError (_.Library.Status sc)
	Event handler for any error that occurs on the page. More...

_.Library.Status	OnPostHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked after a hyperevent method is called on this page.

_.Library.Status	Page (_.Library.Boolean skipheader)
	Process a request to serve a CSPPage. More...

_.Library.String	QuoteJS (in)
	This method converts input string into quoted JavaScript literal.

_.Library.String	RewriteURL (_.Library.String url)
	This method will rewrite a URL to use #url()# if needed.

	ShowError (_.Library.Status sc)
	Display a <class>Status</class> error code to the CSP Page.

	StartTimer (_.Library.String name)
	Used to get performance information on your CSP pages. More...

	StopTimer (_.Library.String name)
	Used to time performance information on your CSP pages. More...

	ThrowError (_.Library.Status sc)
	Passed a <class>Status</class> code this goes to the error page passing this status code.

_.Library.String	UnescapeHTML (in)
	This method converts Escaped HTML text into normal HTML text.

_.Library.String	UnescapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in Escaped URL string back to its original form. More...

Static Public Member Functions inherited from Base
_.Library.String	AfterUserAction (_.ZEN.proxyObject pInputProxy, _.ZEN.proxyObject pOutputProxy, _.ZEN.proxyObject pUserData)
	Server-side wrapper around the AfterUserAction callback.

	AppendSourceControlOutput (_.Library.String pOutput)
	Add output to the session data on the server.

_.Library.Integer	ClearSourceControlOutput ()
	Clear the output for the session.

	CreateProject (_.ZEN.proxyObject pInputProxy, _.ZEN.proxyObject pOutputProxy)
	Create a new Studio project on the server.

_.Library.String	DocumentLoad (_.ZEN.proxyObject pInputProxy, _.ZEN.proxyObject pOutputProxy)
	Implement the correct callbacks around loading a document.

_.Library.String	DocumentSave (_.ZEN.proxyObject pInputProxy, _.ZEN.proxyObject pOutputProxy)
	Implement the correct callbacks around saving a document.

_.Library.Status	GetSourceControlCommands (_.Library.Boolean pDisplay, pCommands, _.Library.Boolean pNeedProject, _.Library.String pServerOutput)
	Determine which source control commands should be drawn for the current context.

_.Library.String	GetTimestamp (_.Library.String classname)
	Get the timestamp for the current document.

_.Library.Boolean	HaveSourceControlOutput ()
	Indicate whether there is Source Control output for the session.

_.Library.Status	LoadProject (_.Studio.SourceControl.Base pSourceControl, _.Library.String pProject, _.Library.Boolean pRedirect)
	Load the named project in pProject using the source control object. More...

_.Library.String	UserAction (_.ZEN.proxyObject pInputProxy, _.ZEN.proxyObject pOutputProxy)
	Server-side wrapper around the UserAction callback.

Static Public Member Functions inherited from Util
_.Library.Status	CreateSourceControl (_.Studio.SourceControl.Base pSourceControl, _.Library.Boolean pCreated, _.Library.String pUsername, _.ZEN.proxyObject pUserData)
	Create an instance of a Source Control object.

_.Library.String	GetCurrentProject (_.Library.Boolean pLoaded)
	Helper method to retrieve the current project for the CSP session,. More...

	GetFullProjectName (_.Library.String pProjectName)
	Return a project's full name, including a ".PRJ" extension.

_.Library.String	GetSourceControlClass ()
	Return the source control class which is to be used in the current namespace. More...

_.Library.Boolean	IsEnabled (_.Library.String pNamespace)
	Determine whether source control is enabled for the Management. More...

_.Library.Boolean	IsProjectRequired ()
	Helper method to indicate whether the source control hooks in the current. More...

	SetCurrentProject (_.Library.String pProjectName, _.Library.Boolean pLoaded)
	Helper method to save the name of the current project and whether its. More...

_.Library.Status	SetProjectRequired (_.Library.Boolean pNewValue, _.Library.Boolean pOldValue)
	Enable or disable the flag indicating whether the source control class. More...

Public Attributes
	autosave
	Token to load unsaved pivot state. More...

	autosaveOverride
	Token to ignore autosave behavior (used with "Clear My Settings") More...

	dashboardBookCover
	Book cover spec of the currently displayed dashboard. More...

	dashboardCategory
	Category for the currently displayed dashboard. More...

	dashboardDescription
	Description of the currently displayed dashboard. More...

	dashboardGridCols
	Is dashboard uses snap grid, then this is then number of grid columns. More...

	dashboardGridRows
	Is dashboard uses snap grid, then this is then number of grid rows. More...

	dashboardKeywords
	Keywords for the currently displayed dashboard. More...

	dashboardLocked
	Locked state of the currently displayed dashboard. More...

	dashboardModify
	Does this dashboard allow the user to modify widgets. More...

	dashboardName
	Name of the currently displayed dashboard. More...

	dashboardOwner
	Owner of the currently displayed dashboard. More...

	dashboardPublic
	Public state of the currently displayed dashboard. More...

	dashboardResize
	Does this dashboard allow the user to move and resize widgets. More...

	dashboardResource
	Resource for the currently displayed dashboard. More...

	dashboardSnapGrid
	If true, the dashboard uses the new snapGrid desktop and ignores the. More...

	dashboardSnapTo
	Is dashboard in "snap to" mode. More...

	dashboardTitle
	Title of the currently displayed dashboard. More...

	dashboardTitleLocal
	Localized title of the currently displayed dashboard. More...

	nonce
	This is used when launching a dashboard from an email alert. More...

	pdfPreserveTempFiles
	Debugging property. More...

	printMarginBottom
	Container for the page's bottom margin when printing widgets in multi-print mode. More...

	printMarginLeft
	Container for the page's left margin when printing widgets in multi-print mode. More...

	printMarginRight
	Container for the page's right margin when printing widgets in multi-print mode. More...

	printMarginTop
	Container for the page's top margin when printing widgets in multi-print mode. More...

	printMasterWidgetId
	If the dashboard is in multi-print mode, there is master widget which defines the. More...

	printPageOrientation
	Container for the page orientation when printing widgets in multi-print mode. More...

	printPageSize
	Container for the page size when printing widgets in multi-print mode. More...

	readOnly
	If true, user cannot modify the current dashboard. More...

	saveAction
	Container for the current save mode for source control. More...

	selectedTitleBarColor
	Specify color of title bar for selected widgets. More...

	selectedTitleBarOpacity
	Specify opacity of title bars for selected widgets. More...

	selectedTitleBarTextColor
	Specify color of title bar text for selected widgets. More...

	showTitleBar
	If true, widgets display a title bar. More...

	tempFileToken
	When creating multiple temp files, a token is generated that is unique to the. More...

	tempStorageRoot
	Folder for autosave items. More...

	titleBarColor
	Specify color of title bars. More...

	titleBarFont
	Specify font of title bar text. More...

	titleBarOpacity
	Specify opacity of title bars. More...

	titleBarTextColor
	Specify color of title bar text. More...

	trace
	If true, show alert message to trace filter events. More...

	userName
	Current user name. More...

	widgetBorders
	border of widgets in dashboard More...

	widgetBordersColor
	color of widgets border More...

	widgetBordersStyle
	style of widgets border, e.g. More...

	widgetBordersSwitch
	Whether border is none, inherit or "width style color". More...

	widgetBordersToggle
	Whether borders of widgets are on or off. More...

	widgetBordersWidth
	width of widgets border More...

	widgetDescription
	Description of the widget (if any). More...

	widgetKeywords
	Keywords of the saved widget (if any). More...

	widgetNamesAdded
	Indicates whether or not the page had to generate widget names on load. More...

	widgetOwner
	Widget owner. More...

	widgetResource
	Widget resource. More...

	widgetTemplateName
	Name used to save a widget to the catalog! More...

Public Attributes inherited from standardPage
	StdTitle
	Define the title that will be displayed within subclasses. More...

	aboutPage
	About page URL. More...

	alertId
	ID of alert that launched this page, if any. More...

	canWrite
	If true, user can modify this page. More...

	chartSeriesColors
	Chart series color list. More...

	chartSeriesScheme
	Chart series color scheme. More...

	companyLogo
	Local override of company logo. More...

	companyName
	Local override of company name. More...

	companyStyle
	Local override of company cell style. More...

	homePage
	URL of the Home Page. More...

	isEmbedded
	Convenience property. More...

	limitPopups
	Set to true to suppress hyperevent error pop-ups in. More...

	noBorder
	If true, then do not display the outer border around the desktop area of this page. More...

	noModify
	If true, then do not allow user to modify this page (this is only a convenience, it is. More...

	noTitle
	If true, then do not display the title area of this page. More...

	searchKey
	Current search key. More...

	urlWorklistCount
	If set override the worklist count (number of worklist boxes on side of page). More...

	useClientEmail
	If true, send e-mail using client-side mailto application. More...

	viewerURL
	URL of viewer page. More...

	worklistCount
	Number of worklist panels to display: 0,1,or 2. More...

Public Attributes inherited from abstractPage
	backgroundTimerInterval
	This is the interval, in milliseconds, at which timer events are fired in order. More...

	cssLevel
	This property specifies what level of CSS support is used by this page. More...

	dragAndDrop
	If true, then drag and drop supported is enabled for this page. More...

	title
	Title of this page. More...

	useSVG
	If true, then the various JavaScript include files for SVG component are included for this page. More...

	useSoftModals
	This property specifies whether modal dialogs launched using zenLaunchPopupWindow() should. More...

	zenPersistentPopup
	This flag indicates whether the current Zen page should not sever its connection to its. More...

Public Attributes inherited from group
	cellAlign
	Specifies horizontal alignment of cells layed out within this group. More...

	cellSize
	Specifies how the size of cells within this group should be calculated (along layout direction). More...

	cellStyle
	Specifies additional style for cells layed out within this group. More...

	cellVAlign
	Specifies vertical alignment of cells layed out within this group. More...

	groupClass
	Optional CSS class used for table displayed by this group. More...

	groupStyle
	Optional style used for table displayed by this group. More...

	labelPosition
	Specifies where labels should be displayed for components within this group. More...

	layout
	Specifies how components within this group should be layed out. More...

	onclick
	onclick event handler: More...

Public Attributes inherited from abstractGroup
	children
	Set of components within this group. More...

	disabled
	If true, this group and its children are disabled. More...

Public Attributes inherited from component
	align
	Specifies how this component should be horizontally aligned within its layout cell. More...

	containerStyle
	CSS style applied to the td element used to contain this child component within. More...

	dragEnabled
	If this value is true and dragAndDrop is enabled for the page, then. More...

	dropEnabled
	If this value is true and dragAndDrop is enabled for the page, then. More...

	enclosingClass
	Optional CSS class used for this component's enclosing div. More...

	enclosingStyle
	Optional CSS style applied to this component's enclosing div. More...

	error
	Run-time value; Set to indicate an error within this component. More...

	height
	Specifies the height of this component with respect to its container. More...

	hidden
	If true, this component is hidden. More...

	hint
	User defined hint text used to display additional hint text for this component. More...

	hintClass
	Optional CSS class used for the component hint. More...

	hintStyle
	User defined style used for the component hint. More...

	label
	User defined label used to label this component. More...

	labelClass
	Optional CSS class used for the component label. More...

	labelDisabledClass
	Optional CSS class used for the component label when disabled. More...

	labelStyle
	User defined style used for the component label. More...

	onafterdrag
	onafterdrag event handler: More...

	onbeforedrag
	onbeforedrag event handler: More...

	ondrag
	ondrag event handler: More...

	ondrop
	ondrop event handler: More...

	onhide
	onhide event handler: More...

	onrefresh
	onrefresh event handler: More...

	onshow
	onshow event handler: More...

	showLabel
	Controls whether a label is displayed for this component. More...

	slice
	User-defined number of units of relative space this. More...

	title
	Help text (tool tip) displayed when mouse hovers over this component (or its label). More...

	valign
	Specifies how this component should be vertically aligned within its layout cell. More...

	width
	Specifies the width of this component with respect to its container. More...

Public Attributes inherited from object
	aux
	@qualifier final This is an auxiliary property that is provided More...

	composite
	@qualifier final For components that are created as part of a composite component, More...

	id
	@qualifier final This is a unique identifier that is used to distinguish this object More...

	index
	@qualifier final System-assigned index number used internally to identify this component. More...

	name
	@qualifier final Name of this object. More...

	onupdate
	onupdate event handler: More...

	parent
	@qualifier final Link to the component that contains this object More...

	tuple
	@qualifier final Special property indicating which tuple of a More...

	visible
	This property indicates whether a component is visible and thus layed out. More...

	window
	@qualifier final This is a client-only property that refers to the JavaScript More...

Public Attributes inherited from abstractRefreshable
	enableAutoRefresh
	True if pages in the management portal are permitted to use auto-refresh behaviour. More...

Public Attributes inherited from Base
	canEdit
	Flag to indicate whether the user is permitted to make any changes on a given page. More...

	currentNamespace
	The current namespace. More...

	currentProject
	The name of the currently active/selected project. More...

	currentUser
	The current user's username. More...

	hasSCOutput
	Flag to indicate whether source control output is present in the current session. More...

	msgNotPermitted
	Message to inform the user they may not perform a given action. More...

	needProject
	Flag to indicate whether a project is needed for the current source control hooks. More...

	readOnly
	If true, user cannot modify the current document. More...

	readOnlyReason
	Indicator for why a document was marked as readOnly. More...

	renamed
	Flag to indicate whether the document has been renamed via "Save As". More...

	sourceControlEnabled
	Flag to indicate whether source control hooks are enabled for the current namespace. More...

	sourceControlManagerDialog
	Name of the manager page to use for managing popups requested by the source control class. More...

	sourceControlNewlineFormat
	Flag to control what newline format should be used for reporting data from the server. More...

	sourceControlOutputDialog
	Name of the output dialog to use. More...

	sourceControlVisible
	Flag to indicate whether the source control output is currently visible. More...

Static Public Attributes
	JSINCLUDES = None
	The DeepSee DashBoard viewer page. More...

	PAGENAME = None
	Name of this page.

	WORKLIST1MODE = None
	Starting mode for worklist 1: html or group.

Static Public Attributes inherited from standardPage
	APPLICATION = None
	Base class for pages within the DeepSee user portal. More...

	DOMAIN = None
	Set this to the correct domain.

	FAVORITEICON = None
	DeepSee favorite icon.

	HOMEPAGE = None
	URL of home page (used in links).

	PAGENAME = None
	Name of this page.

	RESOURCE = None
	All DeepSee pages require DeepSee_Portal USE.

	WORKLIST1MODE = None
	Starting mode for worklist 1: html or group.

	WORKLIST2MODE = None
	Starting mode for worklist 2: html or group.

Static Public Attributes inherited from page
	POSTCOMPILEACTIONS = None
	Internal parameter. More...

	VALIDATEXML = None
	Validate user pages.

	XMLINCLUDEINGROUP = None
	User pages do not have an XML representation.

	XMLNAME = None
	Reset XMLNAME parameter.

Static Public Attributes inherited from abstractPage
	APPLICATION = None
	This is the class name of this application this page belongs to. More...

	AUTOLOGOUT = None
	If true, then attempt to refresh this page when its session timeout period has expired. More...

	AUTONS = None
	If true, auto-switch namespace to whatever $NAMESPACE is passed in.

	CHECKMODIFIEDBEFORELOGOUT = None
	If true and AUTOLOGOUT is true then call onhandleAutoLogout 30 seconds. More...

	CLIENTCACHE = None
	If false (the default) disable browser caching of pages.

	CSS3INCLUDES = None
	Comma-separated list of additional CSS3 include files for the page. More...

	CSSINCLUDES = None
	Comma-separated list of additional CSS include files for the page. More...

	DOMAIN = None
	Localization domain.

	ERRORDIVID = None
	The id of the <div> element used to display errors encountered in the page definition. More...

	FAVORITEICON = None
	If defined, this is the url of the "favorite" (or shortcut) icon to display for this page. More...

	HTMLATTRS = None
	If defined, this string will be written as attributes within the html element at. More...

	HTMLDOCTYPE = None
	If HTMLDTD is true we will look here for the DOCTYPE declaration. More...

	HTMLDTD = None
	If true, draw an HTML Document Type Declaration at the start of this page.

	IFRAMEALLOWED = None
	Allow pages to have iframes by not setting x-frame-options: same origin. More...

	INLINESVG = None
	Experimental parameter. More...

	JSINCLUDES = None
	Comma-separated list of additional JS include files for the page.

	PAGENAME = None
	Optional. More...

	PAGETITLE = None
	Optional. More...

	RESOURCE = None
	This is a comma-delimited list of system Resources and associated. More...

	SHOWSTATS = None
	If true, then display server statistics (within a comment) at the end of this page.

	SYSTEMMODULES = None
	Comma-separated list of Zen library modules whose HTML class. More...

	USERPACKAGES = None
	Comma-separated list of User class packages whose HTML class. More...

	USERSVGPACKAGES = None
	Comma-separated list of User class packages whose SVG class. More...

	VALIDATEXML = None
	If true, validate XML Contents using the Zen schema.

Static Public Attributes inherited from group
	DEFAULTCELLALIGN = None
	Subclasses can set this to change default cellAlign for a group.

	DEFAULTCELLSIZE = None
	Subclasses can set this to change default cellSize for a group.

	DEFAULTCELLSTYLE = None
	Subclasses can set this to change default cellStyle for a group.

	DEFAULTCELLVALIGN = None
	Subclasses can set this to change default cellVAlign for a group.

	DEFAULTGROUPCLASS = None
	Subclasses can set this to change default css class for a group.

	DEFAULTGROUPSTYLE = None
	Subclasses can set this to change default groupStyle for a group.

	DEFAULTLABELPOSITION = None
	Subclasses can set this to change default labelPosition for a group.

	DEFAULTLAYOUT = None
	Subclasses can set this to change default layout for a group.

Static Public Attributes inherited from abstractGroup
	DEFAULTGROUPCLASS = None
	Subclasses can set this to change default css class for a group.

Static Public Attributes inherited from component
	DEFAULTENCLOSINGCLASS = None
	Subclasses can set this to change default enclosingClass used for this. More...

	DEFAULTHEIGHT = None
	Subclasses can set this to change default height for a component.

	DEFAULTHIDDEN = None
	Subclasses can set this to change default hidden property for a component.

	DEFAULTHINTCLASS = None
	Subclasses can set this to change default css class used for hints.

	DEFAULTLABELCLASS = None
	Subclasses can set this to change default css class used for labels.

	DEFAULTLABELDISABLEDCLASS = None
	Subclasses can set this to change default css class used for disabled labels.

	DEFAULTVISIBLE = None
	Subclasses can set this to change default visibilty for a component.

	DEFAULTWIDTH = None
	Subclasses can set this to change default width for a component.

Static Public Attributes inherited from object
	DEFAULTVISIBLE = None
	Subclasses can set this to change default visibilty for a component.

	INCLUDEFILES = None
	CSV list of additional include files (either .js or .css) that. More...

	MODULE = None
	If set, this indicates that this system component should be. More...

	NAMESPACE = None
	This is the XML namespace used for library components.

	POSTCOMPILEACTIONS = None
	This is a comma-delimited list of which post-compile actions this component. More...

	USECOMMONDIRECTORY = None
	If true, then the include files generated for this component, are placed in the. More...

	XMLFORMAT = None
	If XMLFORMAT="Literal", then only support for literal format import and export is generated. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	By setting this to 0, we disallow use of invalid attribute names in Zen XML documents.

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Static Public Attributes inherited from Page
	CHARSET = None
	The <CLASS>CSP.Page</CLASS> object serves as an event handler for CSP requests. More...

	CONTENTTYPE = None
	Specifies the default content type for the page. More...

	CONVERTINPUTSTREAM = None
	Specifies if input request.Content or request.MimeData values are converted from their. More...

	CSPFILE = None
	If this page was compiled from a .csp file, then this parameter contains the. More...

	CSPSTRICT = None
	The CSPSTRICT parameter is set to 1, if the DOCTYPE indicates that this. More...

	CSPURL = None
	This parameter is used to make sure that if multiple. More...

	CSPXHTML = None
	The CSPXHTML parameter is set to 1, if the DOCTYPE indicates that this. More...

	DOMAIN = None
	The default domain for csp:text, span and div tags. More...

	ENCODED = None
	Controls how the query parameters for this page are passed, it can. More...

	ERRORPAGE = None
	Specify a custom error page to call if there are any problems with generating this page. More...

	EXPIRES = None
	Specified the default value for the response.Expires. More...

	NOCHARSETCONVERT = None
	Specifies if we wish to turn off charset conversion for this page. More...

	PAGETIMING = None
	If this parameter is true then we automatically record timing statistics of how long it takes to. More...

	PRIVATE = None
	Controls the access to the page, it can be set to one of the following: More...

	SECURITYRESOURCE = None
	This is a comma-delimited list of system Resources and associated. More...

	TIMINGSLOTS = None
	Used by the timing to decide how many slots a day should be divided up into. More...

	UseSession = None
	This parameter controls the CSP session support. More...

Static Public Attributes inherited from Base
	EDITRESOURCE = None
	Resource for subclasses to indicate whether further resources are needed to perform actions on pages.

	MANAGERDIALOG = None
	Page to use for managing popups requested by the source control framework.

	OUTPUTDIALOG = None
	Page to use for displaying output from the server.

Private Member Functions
_.Library.Status	CreateWidgets (_.DeepSee.Dashboard.Definition pDashboard, _.ZEN.Component.desktop pDesktop, _.Library.String pURLSettings, _.Library.String pDBSettings, _.Library.String pAddedWidget)
	Create the dashboard widgets and add them to the desktop. More...

_.Library.Status	GetDashboardSettings (_.Library.String pDBSettings)
	Get array of "dashboard" settings for this dashboard.

_.Library.Status	LoadDashboard (_.DeepSee.Dashboard.Definition pDashboard, _.Library.String pDashboardName)
	Open (or create) an instance of dashboard definition that defines the contents. More...

_.Library.Status	OnAfterCreatePage ()
	Decorate the page.

_.Library.Status	OnCreateControls (_.DeepSee.Dashboard.Definition pDashboard, _.ZEN.Component.group pGroup)
	Nofication that <method>CreateControls</method> was called.

_.Library.Status	OnCreateWidgets (_.DeepSee.Dashboard.Definition pDashboard, _.ZEN.Component.desktop pDesktop)
	Nofication that <method>CreateWidgets</method> was called.

_.Library.Status	OnDrawHTMLHead ()
	Add include files to support color schemes.

_.Library.String	OnGetPageName ()
	Get the (localized) name of the page. More...

	OnGetSmallMenu (pMenu)
	Get the contents of the small menu in the title area.

_.Library.String	OnGetTitle ()
	Get the (localized) title string for the page. More...

_.Library.Status	OnGetWorklistOptions1 (pOptions, pDefaultMode)
	Return list of options for work list 1.

_.Library.Status	OnGetWorklistOptions2 (pOptions, pDefaultMode)
	Return list of options for work list 2.

Static Private Member Functions
_.Library.Boolean	OnPreHTTP ()
	Translate encrypted URL parameters.

_.Library.Status	ParseFilterSpec (_.Library.String pSpec, _.Library.String pFSpec, _.Library.String pFKey, _.Library.String pFValue, _.Library.Integer pIndex)
	Utility method. More...

Detailed Description

The DeepSee DashBoard viewer page.

This page displays a saved DeepSee dashboard. Invoke this page using the URL:
_DeepSee.UserPortal.DashboardViewer.zen?DASHBOARD=dashboardname
Where dashboardname is the full name of the dashboard: e.g., "folder/name.dashboard"
This class should be considered as internal; subclassing is not supported.

Member Function Documentation

◆ CreateWidgets()

_.Library.Status CreateWidgets	(	_.DeepSee.Dashboard.Definition	pDashboard,
		_.ZEN.Component.desktop	pDesktop,
		_.Library.String	pURLSettings,
		_.Library.String	pDBSettings,
		_.Library.String	pAddedWidget
	)

private

Create the dashboard widgets and add them to the desktop.

pURLSettings is an array of settings values pulled out of the URL.
pDBSettings is an array of saved dashboard settings values.

◆ LoadDashboard()

_.Library.Status LoadDashboard	(	_.DeepSee.Dashboard.Definition	pDashboard,
		_.Library.String	pDashboardName
	)

private

Open (or create) an instance of dashboard definition that defines the contents.

of this dashboard.

◆ OnGetPageName()

_.Library.String OnGetPageName ( )

private

Get the (localized) name of the page.

This should be implemented in a subclass.

Reimplemented from standardPage.

◆ OnGetTitle()

_.Library.String OnGetTitle ( )

private

Get the (localized) title string for the page.

This should be implemented in a subclass.

Reimplemented from standardPage.

◆ ParseFilterSpec()

_.Library.Status ParseFilterSpec	(	_.Library.String	pSpec,
		_.Library.String	pFSpec,
		_.Library.String	pFKey,
		_.Library.String	pFValue,
		_.Library.Integer	pIndex
	)

staticprivate

Utility method.

Pull apart a filter spec, as we may get from a URL, into a spec and key or value:
[Outlet].[Country].[France] ==> "[Outlet].[Country]","[France]"
{[HOMED].[H1].[ZIP].[32006],[HOMED].[H1].[ZIP].[32007]} ==> "[HOMED].[H1].[ZIP]","{&[32006],&[32007]}"
Note that an array of results is returned. If the spec contains a tuple, each piece is put into its own array node (pIndex is used to track how many pieces there are).

◆ GetDimensionInfo()

_.Library.Status GetDimensionInfo	(	_.Library.String	pRoot,
			pTree,
			pParms
	)

static

Provide contents of the dimension tree.

Used by pivot widget.

◆ GetInternalName()

_.Library.String GetInternalName ( )

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. Subclasses MUST override this method.

Reimplemented from Base.

◆ GetOptionList()

_.Library.Status GetOptionList	(	pParameters,
		pMetaData,
		pData
	)

Return JSON array of options.

◆ GetWidgetTypeList()

_.Library.Status GetWidgetTypeList	(	pParameters,
		pMetaData,
		pData
	)

Return JSON array of widget types.

◆ SubmitDashboardDef()

_.Library.Status SubmitDashboardDef	(	_.Library.String	pCommand,
		_.ZEN.Auxiliary.jsonProvider	pProvider,
		_.DeepSee.Dashboard.Definition	pSubmitObject,
		_.Library.RegisteredObject	pResponseObject
	)

Submit handler for the dashboard definition.

This is called when the dashboard is saved.

◆ actionHandler()

actionHandler	(	widget,
		dataSource,
		action
	)

This handles any actions that were not handled by the widgets on the dashboard.

This is done by sending the event to the server-side dataSource.

◆ clearAutosaveState()

clearAutosaveState ( )

Remove any autosave state associated with this dashboard – the dashboard.

should load fresh

◆ dashboardEventHandler()

dashboardEventHandler	(	sourceWidget,
		which,
		control,
		action,
		target,
		targetProperty,
		varType
	)

Central handler for control events on this dashboard.

This is called whenever a control is modified (or otherwise activated). This is also called when a widget raises an event.
sourceWidget is the widget that raised the event.
which is either 'control' for controls or 'click' for click on widget element. Return true if the event was handled.

◆ getClientModel()

getClientModel ( )

Get the jsonProvider object on the client.

Subclasses MUST override this method to return the jsonProvider.

Reimplemented from Base.

◆ getCurrentExtension()

getCurrentExtension ( )

Return the extension used by Studio for the class/object.

This is ".CLS" by default, but subclasses should override this method if a different extension is in use.

Reimplemented from Base.

◆ getCurrentName()

getCurrentName ( )

Return the current name of the class/object being modified.

Subclasses MUST override this method to return the correct name.

Reimplemented from Base.

◆ getSaveAction()

getSaveAction ( force )

Return the string used as the command when sending JSON content to the server.

The OnSubmitContent handler for the jsonProvider MUST support two action types.

Reimplemented from Base.

◆ getToolbarData()

getToolbarData ( )

Return json data to drive the toolbar.

!!!

◆ getWidgetLayout()

getWidgetLayout ( )

Get the current size and position of each widget and place it within the widget.

Also make sure that the subtype class is current.

◆ onunloadHandler()

onunloadHandler ( )

This client event, if present, is fired when the page is unloaded.

If this method returns a string value, then that is used as the return value of the HTML page's onbeforeunload handler (if more than one component returns a string, the first one encountered is used).

Reimplemented from object.

◆ removeMenuOption()

removeMenuOption ( _.Library.String option )

Helper method to remove a menu option.

Used to remove edit/save options in read-only mode.

◆ saveDashboard()

saveDashboard	(	show,
		autosaveDashboard
	)

Launch the save dialog.

If show is true, show the dialog.

◆ setProperty()

setProperty	(	property,
		value,
		value2
	)

Set the value of a named property.

Reimplemented from standardPage.

◆ setReadOnly()

setReadOnly ( readOnly )

Set <property>readOnly</property> to the value of readOnly.

Subclasses MUST implement this method to update the controls on the page so that the page's behaviour actually matches the value of the readOnly flag.

Reimplemented from Base.

Member Data Documentation

◆ JSINCLUDES

JSINCLUDES = None

static

The DeepSee DashBoard viewer page.

This page displays a saved DeepSee dashboard. Invoke this page using the URL:
_DeepSee.UserPortal.DashboardViewer.zen?DASHBOARD=dashboardname
Where dashboardname is the full name of the dashboard: e.g., "folder/name.dashboard"
This class should be considered as internal; subclassing is not supported.

Pick up formula code.

◆ autosave

autosave

Token to load unsaved pivot state.

◆ autosaveOverride

autosaveOverride

Token to ignore autosave behavior (used with "Clear My Settings")

◆ dashboardBookCover

dashboardBookCover

Book cover spec of the currently displayed dashboard.

◆ dashboardCategory

dashboardCategory

Category for the currently displayed dashboard.

◆ dashboardDescription

dashboardDescription

Description of the currently displayed dashboard.

◆ dashboardGridCols

dashboardGridCols

Is dashboard uses snap grid, then this is then number of grid columns.

◆ dashboardGridRows

dashboardGridRows

Is dashboard uses snap grid, then this is then number of grid rows.

◆ dashboardKeywords

dashboardKeywords

Keywords for the currently displayed dashboard.

◆ dashboardLocked

dashboardLocked

Locked state of the currently displayed dashboard.

◆ dashboardModify

dashboardModify

Does this dashboard allow the user to modify widgets.

◆ dashboardName

dashboardName

Name of the currently displayed dashboard.

Use XDASHBOARD to use a session encrypted value for this.

◆ dashboardOwner

dashboardOwner

Owner of the currently displayed dashboard.

◆ dashboardPublic

dashboardPublic

Public state of the currently displayed dashboard.

◆ dashboardResize

dashboardResize

Does this dashboard allow the user to move and resize widgets.

◆ dashboardResource

dashboardResource

Resource for the currently displayed dashboard.

◆ dashboardSnapGrid

dashboardSnapGrid

If true, the dashboard uses the new snapGrid desktop and ignores the.

the <property>dashboardSnapTo</property> property.

◆ dashboardSnapTo

dashboardSnapTo

Is dashboard in "snap to" mode.

◆ dashboardTitle

dashboardTitle

Title of the currently displayed dashboard.

◆ dashboardTitleLocal

dashboardTitleLocal

Localized title of the currently displayed dashboard.

◆ nonce

nonce

This is used when launching a dashboard from an email alert.

◆ pdfPreserveTempFiles

pdfPreserveTempFiles

Debugging property.

Setting this to true will prevent the pdf viewer from deleting

temporary files used for printing when launched.

◆ printMarginBottom

printMarginBottom

Container for the page's bottom margin when printing widgets in multi-print mode.

◆ printMarginLeft

printMarginLeft

Container for the page's left margin when printing widgets in multi-print mode.

◆ printMarginRight

printMarginRight

Container for the page's right margin when printing widgets in multi-print mode.

◆ printMarginTop

printMarginTop

Container for the page's top margin when printing widgets in multi-print mode.

◆ printMasterWidgetId

printMasterWidgetId

If the dashboard is in multi-print mode, there is master widget which defines the.

page margins and other overall settings in the pdf report. This property is the container for the reference to that widget.

◆ printPageOrientation

printPageOrientation

Container for the page orientation when printing widgets in multi-print mode.

◆ printPageSize

printPageSize

Container for the page size when printing widgets in multi-print mode.

◆ readOnly

readOnly

If true, user cannot modify the current dashboard.

◆ saveAction

saveAction

Container for the current save mode for source control.

◆ selectedTitleBarColor

selectedTitleBarColor

Specify color of title bar for selected widgets.

◆ selectedTitleBarOpacity

selectedTitleBarOpacity

Specify opacity of title bars for selected widgets.

◆ selectedTitleBarTextColor

selectedTitleBarTextColor

Specify color of title bar text for selected widgets.

◆ showTitleBar

showTitleBar

If true, widgets display a title bar.

◆ tempFileToken

tempFileToken

When creating multiple temp files, a token is generated that is unique to the.

CSP session. Temporary files incoporate this token to avoid concurrency problems.

◆ tempStorageRoot

tempStorageRoot

Folder for autosave items.

◆ titleBarColor

titleBarColor

Specify color of title bars.

◆ titleBarFont

titleBarFont

Specify font of title bar text.

◆ titleBarOpacity

titleBarOpacity

Specify opacity of title bars.

◆ titleBarTextColor

titleBarTextColor

Specify color of title bar text.

◆ trace

trace

If true, show alert message to trace filter events.

◆ userName

userName

Current user name.

◆ widgetBorders

widgetBorders

border of widgets in dashboard

◆ widgetBordersColor

widgetBordersColor

color of widgets border

◆ widgetBordersStyle

widgetBordersStyle

style of widgets border, e.g.

solid, dashed, dotted

◆ widgetBordersSwitch

widgetBordersSwitch

Whether border is none, inherit or "width style color".

◆ widgetBordersToggle

widgetBordersToggle

Whether borders of widgets are on or off.

◆ widgetBordersWidth

widgetBordersWidth

width of widgets border

◆ widgetDescription

widgetDescription

Description of the widget (if any).

Used for save to catalog.

◆ widgetKeywords

widgetKeywords

Keywords of the saved widget (if any).

Used for save to catalog.

◆ widgetNamesAdded

widgetNamesAdded

Indicates whether or not the page had to generate widget names on load.

◆ widgetOwner

widgetOwner

Widget owner.

Used for save to catalog.

◆ widgetResource

widgetResource

Widget resource.

Used for save to catalog.

◆ widgetTemplateName

widgetTemplateName

Name used to save a widget to the catalog!

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ CreateWidgets()

◆ LoadDashboard()

◆ OnGetPageName()

◆ OnGetTitle()

◆ ParseFilterSpec()

◆ GetDimensionInfo()

◆ GetInternalName()

◆ GetOptionList()

◆ GetWidgetTypeList()

◆ SubmitDashboardDef()

◆ actionHandler()

◆ clearAutosaveState()

◆ dashboardEventHandler()

◆ getClientModel()

◆ getCurrentExtension()

◆ getCurrentName()

◆ getSaveAction()

◆ getToolbarData()

◆ getWidgetLayout()

◆ onunloadHandler()

◆ removeMenuOption()

◆ saveDashboard()

◆ setProperty()

◆ setReadOnly()

Member Data Documentation

◆ JSINCLUDES

◆ autosave

◆ autosaveOverride

◆ dashboardBookCover

◆ dashboardCategory

◆ dashboardDescription

◆ dashboardGridCols

◆ dashboardGridRows

◆ dashboardKeywords

◆ dashboardLocked

◆ dashboardModify

◆ dashboardName

◆ dashboardOwner

◆ dashboardPublic

◆ dashboardResize

◆ dashboardResource

◆ dashboardSnapGrid

◆ dashboardSnapTo

◆ dashboardTitle

◆ dashboardTitleLocal

◆ nonce

◆ pdfPreserveTempFiles

◆ printMarginBottom

◆ printMarginLeft

◆ printMarginRight

◆ printMarginTop

◆ printMasterWidgetId

◆ printPageOrientation

◆ printPageSize

◆ readOnly

◆ saveAction

◆ selectedTitleBarColor

◆ selectedTitleBarOpacity

◆ selectedTitleBarTextColor

◆ showTitleBar

◆ tempFileToken

◆ tempStorageRoot

◆ titleBarColor

◆ titleBarFont

◆ titleBarOpacity

◆ titleBarTextColor

◆ trace

◆ userName

◆ widgetBorders

◆ widgetBordersColor

◆ widgetBordersStyle

◆ widgetBordersSwitch