OWF 7 JSDoc

JavaScript API Reference Document

The following is a summary of the OWF JavaScript APIs. Detailed descriptions of each API is found in the JavaScript document located in the OWF Help Bundle.

• OWF
• OWF.Chrome
• OWF.DragAndDrop
• OWF.Eventing
• OWF.Intents
• OWF.Lang
• OWF.Launcher
• OWF.Log
• OWF.Metrics
• OWF.Preferences
• OWF.RPC
• OWF.Util

* [Ozone.chrome.WidgetChrome](OWF-7-JSDoc#class-ozonechromewidgetchrome) * [Ozone.dragAndDrop.WidgetDragandDrop](OWF-7-JSDoc#class-ozonedraganddropwidgetdraganddrop) * [Ozone.eventing.Widget](OWF-7-JSDoc#class-ozoneeventingwidget) * [Ozone.eventing.WidgetProxy](OWF-7-JSDoc#class-ozoneeventingwidgetproxy) * [Ozone.lang](OWF-7-JSDoc#class-ozonelang) * [Ozone.launcher.WidgetLauncher](OWF-7-JSDoc#class-ozonelauncherwidgetlauncher) * [Ozone.launcher.WidgetLauncherUtils](OWF-7-JSDoc#class-ozonelauncherwidgetlauncherutils) * [Ozone.log](OWF-7-JSDoc#class-ozonelog) * [Ozone.metrics](OWF-7-JSDoc#namespace-ozonemetrics) * [Ozone.pref.PrefServer](OWF-7-JSDoc#class-ozoneprefprefserver) * [Ozone.state.WidgetState](OWF-7-JSDoc#class-ozonestatewidgetstate) * [Ozone.state.WidgetStateHandler](OWF-7-JSDoc#class-ozonestatewidgetstatehandler) * [Ozone.util](OWF-7-JSDoc#namespace-ozoneutil) * [Ozone.util.pageLoad](OWF-7-JSDoc#namespace-ozoneutilpageload)

Namespace: OWF

Defined in: Widget.js

Namespace Summary
OWF
Field Summary
OWF.relayFile	The location of the widget relay file.
Method Summary
OWF.getContainerName()	Returns the name of the Container the Widget is in.
OWF.getContainerUrl()	Returns the URL of the Container the Widget is in.
OWF.getContainerVersion()	Returns the version of the Container the Widget is in.
OWF.getCurrentTheme()	Returns an object containing information on the current OWF theme.
OWF.getDashboardLayout()	Returns type of dashboard in which the widget is opened.
OWF.getIframeId()	Returns the Widget Id.
OWF.getInstanceId()	Returns instance GUID of the widget.
OWF.getOpenedWidgets(callback)	Gets all opened widgets on the current dashboard.
OWF.getUrl()	Returns URL of the widget.
OWF.getVersion()	Returns version of the widget.
OWF.getWidgetGuid()	Returns definition GUID of the widget.
OWF.isDashboardLocked()	Returns whether or not the dashboard in which the widget is opened is locked.
OWF.notifyWidgetReady()	This function should be called once the widget is ready and all initialization is completed.
OWF.ready(handler, scope)	Accepts a function that is executed when Ozone APIs are ready for use.

Namespace: OWF.Chrome

Defined in: Widget.js

Namespace Summary
OWF.Chrome	This object allows a widget to modify the button contained in the widget header (the chrome).
Method Summary
OWF.Chrome.addHeaderButtons(cfg)	Adds buttons to the Widget Chrome.
OWF.Chrome.addHeaderMenus(cfg)	Adds menus to the Widget Chrome.
OWF.Chrome.getTitle(cfg)	Gets the Widget's Title from the Chrome.
OWF.Chrome.insertHeaderButtons(cfg)	Inserts new buttons to the Widget Chrome.
OWF.Chrome.insertHeaderMenus(cfg)	Inserts new menus into the Widget Chrome.
OWF.Chrome.isModified(cfg)	Checks to see if the Widget Chrome has already been modified.
OWF.Chrome.listHeaderButtons(cfg)	Lists all buttons that have been added to the widget chrome.
OWF.Chrome.listHeaderMenus(cfg)	Lists all menus that have been added to the widget chrome.
OWF.Chrome.removeHeaderButtons(cfg)	Removes existing buttons on the Widget Chrome based on itemId.
OWF.Chrome.removeHeaderMenus(cfg)	Removes existing menus on the Widget Chrome based on itemId.
OWF.Chrome.setTitle(cfg)	Sets the Widget's Title in the Chrome.
OWF.Chrome.updateHeaderButtons(cfg)/	Updates any existing buttons in the Widget Chrome based on the itemId.
OWF.Chrome.updateHeaderMenus(cfg)	Updates any existing menus in the Widget Chrome based on the itemId.

Namespace: OWF.DragAndDrop

Defined in: Widget.js

Namespace Summary
OWF.DragAndDrop	The OWF.DragAndDrop object manages the drag and drop for an individual widget.
Method Summary
OWF.DragAndDrop.addDropZoneHandler(cfg)	Adds a new drop zone to be managed.
OWF.DragAndDrop.getDragStartData()	Returns data sent when a drag was started
OWF.DragAndDrop.getDropEnabled()	Returns whether the a drop is enabled (this is only true when the mouse is over a drop zone)
OWF.DragAndDrop.isDragging()	Returns whether a drag is in progress.
OWF.DragAndDrop.onDragStart(callback, scope)	Executes the callback passed when a drag starts in any widget.
OWF.DragAndDrop.onDragStop(callback, scope)	Executes the callback passed when a drag stops in any widget.
OWF.DragAndDrop.onDrop(callback, scope)	Executes the callback passed when a drop occurs in the widget.
OWF.DragAndDrop.setDropEnabled(dropEnabled)	Toggles the dragIndicator to indicate successful or unsuccessful drop
OWF.DragAndDrop.setFlashWidgetId(id)	Use this method to set flex dom element id, so that drag and drop can be enabled in flex widgets.
OWF.DragAndDrop.startDrag(cfg)	Starts a drag.

Namespace: OWF.Eventing

Defined in: Widget.js

Namespace Summary
OWF.Eventing	The OWF.Eventing object manages the eventing for an individual widget.
Method Summary
OWF.Eventing.publish(channelName, message, dest)	Publishes a message to a given channel.
OWF.Eventing.subscribe(channelName, handler)	Subscribe to a named channel for a given function.
OWF.Eventing.unsubscribe(channelName)	Unsubscribe to a named channel.

Namespace: OWF.Intents

Defined in: WidgetIntents.js

Namespace Summary
OWF.Intents
Method Summary
OWF.Intents.receive(intent, handler)	Register to receive an Intent
OWF.Intents.startActivity(intent, data, handler, dest)	Starts an Intent.

Namespace: OWF.Lang

Defined in: Widget.js

Namespace Summary
OWF.Lang	Provides utility methods for localization.
Method Summary
OWF.Lang.getLanguage()	Gets the language that is currently being used by OWF.

Namespace: OWF.Launcher

Defined in: Widget.js

Namespace Summary
OWF.Launcher	This object is used launch other widgets.
Method Summary
OWF.Launcher.getLaunchData()	Retrieves initial launch data for this widget if it is opened by another widget.
OWF.Launcher.launch(config, callback)	Launches a Widget based on the config.

Namespace: OWF.Log

Defined in: Widget.js

Namespace Summary
OWF.Log	Provides functions to log messages and objects.
Method Summary
OWF.Log.getDefaultLogger()	Get OWF's default logger.
OWF.Log.getLogger(loggerName)	Get a logger by name, if the logger has not already been created it will be created.
OWF.Log.launchPopupAppender()	Launch the log window pop-up, this will re-launch the window in the event it has been closed.
OWF.Log.setEnabled(enabled)	Enable/Disable logging for the OWF application.

Namespace: OWF.Metrics

Defined in: Widget.js

Namespace Summary
OWF.Metrics
Method Summary
OWF.Metrics.logBatchMetrics(metrics)	Logs a set of metrics to the server all at once.
OWF.Metrics.logMetric(userId, userName, metricSite, componentName, componentId, componentInstanceId, metricTypeId, metricData)	Basic logging capability - meant to be called by other methods which transform or validate data.
OWF.Metrics.logWidgetRender(userId, userName, metricSite, widget)	Log view of widget - see calls in dashboards.

Namespace: OWF.Preferences

Defined in: Widget.js

Namespace Summary
OWF.Preferences	This object is used to create, retrieve, update and delete user preferences.
Method Summary
OWF.Preferences.cloneDashboard(cfg)	Copies an existing dashboard and saves it as new.
OWF.Preferences.createOrUpdateDashboard(cfg)	Saves changes to a new or existing dashboard.
OWF.Preferences.deleteDashboard(cfg)	Deletes the dashboard with the specified id.
OWF.Preferences.deleteUserPreference(cfg)	Deletes a user preference with the provided namespace and name.
OWF.Preferences.doesUserPreferenceExist(cfg)	Checks for the existence of a user preference for a given namespace and name.
OWF.Preferences.findDashboards(cfg)	Returns all dashboards for the logged in user.
OWF.Preferences.findDashboardsByType(cfg)	Returns all dashboards for the logged in user filtered by the type of dashboard.
OWF.Preferences.findWidgets(cfg)	Gets all widgets for a given user.
OWF.Preferences.getCurrentUser(cfg)	Retrieves the current user logged into the system.
OWF.Preferences.getDashboard(cfg)	Gets the dashboard with the specified id.
OWF.Preferences.getDefaultDashboard(cfg)	Gets the user's default dashboard.
OWF.Preferences.getServerVersion(cfg)	For retrieving the OWF system server version.
OWF.Preferences.getUrl()	Get the url for the Preference Server.
OWF.Preferences.getUserPreference(cfg)	Retrieves the user preference for the provided name and namespace.
OWF.Preferences.getWidget(cfg)	Gets the widget with the specified id.
OWF.Preferences.setDefaultDashboard(cfg)	Sets the user's default dashboard.
OWF.Preferences.setUrl(url)	Sets the url for the Preference Server.
OWF.Preferences.setUserPreference(cfg)	Creates or updates a user preference for the provided namespace and name.
OWF.Preferences.updateAndDeleteDashboards(cfg)	Saves changes to existing dashboards.
OWF.Preferences.updateAndDeleteWidgets(cfg)	Saves changes to existing widgets.

Namespace: OWF.RPC

Defined in: Widget.js

Namespace Summary
OWF.RPC
Method Summary
OWF.RPC.getWidgetProxy(instanceGuid, callback)	Gets a proxy object that contains methods exposed by other widget.
OWF.RPC.handleDirectMessage(fn)	Register a function to be executed when a direct message is received from another widget.
OWF.RPC.registerFunctions(objs)	Register one or more functions to OWF to expose to other widgets.

Namespace: OWF.Util

Defined in: Widget.js

Namespace Summary
OWF.Util	Provides OWF utility methods for the widget developer
Method Summary
OWF.Util.cloneDashboard()	Clones dashboard and returns a dashboard cfg object that can be used to create new dashboards.
OWF.Util.getFlashApp(id)	This method returns flash/flex dom element from dom.
OWF.Util.guid()	Returns a globally unique identifier (guid).
OWF.Util.isInContainer()	This method informs a widget developer if their widget is running in a Container, like OWF.
OWF.Util.isRunningInOWF()	This method informs a widget developer if their widget is running from the OWF or from a direct URL call.

Class: Ozone.chrome.WidgetChrome

Defined in: WidgetChrome.js

Class Summary
Ozone.chrome.WidgetChrome(config)	This object allows a widget to modify the button contained in the widget header (the chrome).
Method Summary
addHeaderButtons(cfg)	Adds buttons to the Widget Chrome.
addHeaderMenus(cfg)	Adds menus to the Widget Chrome.
getInstance(config)	Retrieves Ozone.chrome.WidgetChrome Singleton instance.
getTitle(cfg)	Gets the Widget's Title from the Chrome.
insertHeaderButtons(cfg)	Inserts new buttons to the Widget Chrome.
insertHeaderMenus(cfg)	Inserts new menus into the Widget Chrome.
isModified(cfg)	Checks to see if the Widget Chrome has already been modified.
listHeaderButtons(cfg)	Lists all buttons that have been added to the widget chrome.
listHeaderMenus(cfg)	Lists all menus that have been added to the widget chrome.
removeHeaderButtons(cfg)	Removes existing buttons on the Widget Chrome based on itemId.
removeHeaderMenus(cfg)	Removes existing menus on the Widget Chrome based on itemId.
setTitle(cfg)	Sets the Widget's Title in the Chrome
updateHeaderButtons(cfg)	Updates any existing buttons in the Widget Chrome based on the itemId.
updateHeaderMenus(cfg)	Updates any existing menus in the Widget Chrome based on the itemId.

Class: Ozone.dragAndDrop.WidgetDragAndDrop

Defined in: WidgetDragAndDrop.js

Class Summary
Ozone.dragAndDrop.WidgetDragAndDrop(cfg)	The Ozone.dragAndDrop.WidgetDragAndDrop object manages the drag and drop for an individual widget.
Field Summary
dragStart	dragStart is the name of the event when a drag is started.
dragStop	dragStop is the name of the event when a drag is stopped.
dropReceive	dropReceive is the name of the event when a drop occurs on this widget.
version	version number
Method Summary
addCallback(eventName, cb)	Adds a function as a callback to Drag and Drop events.
addDropZoneHandler(cfg)	Adds a new drop zone to be managed.
doStartDrag(cfg)	Starts a drag.
getDragStartData()	Returns data sent when a drag was started.
getDropEnabled()	Returns whether the a drop is enabled (this is only true when the mouse is over a drop zone).
getInstance(cfg)	Retrieves Ozone.dragAndDrop.WidgetDragAndDrop Singleton instance.
init(cfg)	Initializes the WidgetDragAndDrop object.
isDragging()	Returns whether a drag is in progress.
setDropEnabled(dropEnabled)	Toggles the dragIndicator to indicate successful or unsuccessful drop.

Class: Ozone.eventing.Widget

Defined in: Widget.js

Class Summary
Ozone.eventing.Widget(widgetRelay, afterInit)	The Ozone.eventing.Widget object manages the eventing for an individual widget (Deprecated).
Field Summary
Ozone.eventing.Widget.widgetRelayURL	The location of the widget relay file.
Method Summary
getInstance(afterInit, widgetRelay)	Retrieves Ozone.eventing.Widget Singleton instance.
getWidgetId()	Returns the Widget Id.
publish(channelName, message, dest, accessLevel)	Publish a message to a given channel.
subscribe(channelName, handler)	Subscribe to a named channel for a given function.
unsubscribe(channelName)	Unsubscribe to a named channel.

Class: Ozone.eventing.WidgetProxy

Defined in: WidgetProxy.js

Class Summary
Ozone.eventing.WidgetProxy(wid, functions, srcId, proxy)	Creates or updates a proxy - This is a private constructor - Do not call this directly.
Field Summary
id	Id of the Widget that this proxy represents.
isReady	Flag which represents if the Widget this proxy represents.
Method Summary
onReady(readyListener, readyListenerScope)	Registers a listener function to be executed when the Widget has called notifyReady.
sendMessage(dataToSend)	Sends a direct message to the Widget this proxy represents.

Class: Ozone.lang

Defined in: ozone-lang.js

Class Summary
Ozone.lang()	Provides utility methods for localization.
Method Summary
getLanguage()	Gets the language that is currently being used by OWF.

Class: Ozone.launcher.WidgetLauncher

Defined in: WidgetLauncher.js

Class Summary
Ozone.launcher.WidgetLauncher(widgetEventingController
Method Summary	This object is used launch other widgets.
getInstance()	Retrieves Ozone.eventing.Widget Singleton instance.
launchWidget(config, callback)	Launches a Widget based on the config.

Class: Ozone.launcher.WidgetLauncherUtils

Defined in: WidgetLauncher.js

Class Summary
Ozone.launcher.WidgetLauncherUtils()	Utility functions for a widget that has been launched.
Method Summary
getLaunchConfigData()	Gets initial launch config data for this widget if it was just launched.

Class: Ozone.log

Defined in: log.js

Class Summary
Ozone.log()	Provides functions to log messages and objects.
Method Summary
getDefaultLogger()	Get OWF's default logger.
getLogger(loggerName)	Get a logger by name, if the logger has not already been created it will be created.
launchPopupAppender()	Launch the log window pop-up, this will re-launch the window in the event it has been closed.
setEnabled(enabled)	Enable/Disable logging for the OWF application.

Namespace: Ozone.metrics

Defined in: BaseMetrics.js

Namespace Summary
Ozone.metrics
Method Summary
logBatchMetrics(metrics)	Logs a set of metrics to the server all at once.
logMetric(userId, userName, metricSite, componentName, componentId, componentInstanceId, metricTypeId, metricData)	Basic logging capability - meant to be called by other methods which transform or validate data.
logWidgetRender(userId, userName, metricSite, widget)	Log view of widget - see calls in dashboards.

Class: Ozone.pref.PrefServer

Defined in: preference.js

Class Summary
Ozone.pref.PrefServer(_url)	This object is used to create, retrieve, update and delete user preferences.
Method Summary
cloneDashboard(cfg)	Copies an existing dashboard and saves it as new.
createOrUpdateDashboard(cfg)	Saves changes to a new or existing dashboard.
deleteDashboard(cfg)	Deletes the dashboard with the specified id.
deleteUserPreference(cfg)	Deletes a user preference with the provided namespace and name.
doesUserPreferenceExist(cfg)	Checks for the existence of a user preference for a given namespace and name.
findDashboards(cfg)	Returns all dashboards for the logged in user.
findDashboardsByType(cfg)	Returns all dashboards for the logged in user filtered by the type of dashboard.
findWidgets(cfg)	Gets all widgets for a given user.
getCurrentUser(cfg)	Retrieves the current user logged into the system.
getDashboard(cfg)	Gets the dashboard with the specified id.
getDefaultDashboard(cfg)	Gets the user's default dashboard.
getServerVersion(cfg)	For retrieving the OWF system server version.
getUrl()	Get the url for the Preference Server.
getUserPreference(cfg)	Retrieves the user preference for the provided name and namespace.
getWidget(cfg)	Gets the widget with the specified id.
setDefaultDashboard(cfg)	Sets the user's default dashboard.
setUrl(url)	Sets the url for the Preference Server.
setUserPreference(cfg)	Creates or updates a user preference for the provided namespace and name.
updateAndDeleteDashboards(cfg)	Saves changes to existing dashboards.
updateAndDeleteWidgets(cfg)	Saves changes to existing widgets.

Class: Ozone.state.WidgetState

Defined in: WidgetState.js

Class Summary
Ozone.state.WidgetState(cfg)	The Ozone.state.WidgetState object manages the two-way communication between an OWF widget and its OWF Container.
Field Summary
version	Version number.
Method Summary
activateWidget(cfg)	Activates a widget.
addStateEventListeners(cfg)	Adds custom state event handlers to listen to widget events.
addStateEventOverrides(cfg)	Adds custom state event handlers to override a widget event.
closeWidget(cfg)	Closes a widget.
getInstance(cfg)	Retrieves Ozone.state.WidgetState Singleton instance.
getRegisteredStateEvents(cfg)	Gets registered widget state events.
getWidgetState(cfg)	Gets current widget state.
init(cfg)	Initializes the WidgetState object.
onStateEventReceived()	The default callback function when an event is received.
removeStateEventListeners(cfg)	Removes custom state event listeners from a widget.
removeStateEventOverrides(cfg)	Removes custom state event listeners from a widget.

Class: Ozone.state.WidgetStateHandler

Defined in: WidgetStateHandler.js

Class Summary
Ozone.state.WidgetStateHandler(widgetEventingController)	This object is used handle widget requests.
Method Summary
getInstance(widgetEventingController	Retrieves Ozone.eventing.Widget Singleton instance.
handleWidgetRequest(config, callback)	Handles a widget state request based on the config.

Namespace: Ozone.util

Defined in: widget_utils.js

Namespace Summary
Ozone.util	Provides OWF utility methods for the widget developer.
Method Summary
getFlashApp(id)	This method returns flash/flex object from dom.
guid()	Returns a globally unique identifier (guid)
hasAccess(cfg)	Returns .
isInContainer()	This method informs a widget developer if their widget is running in a Container, like OWF.
isRunningInOWF()	This method informs a widget developer if their widget is running from the OWF or from a direct URL call.

Namespace: Ozone.util.pageLoad

Defined in: pageload.js

Namespace Summary
Ozone.util.pageLoad
Method Summary
afterLoad	Holds current date time after the onload of the widget.
autoSend	Enable or disable the automatic sending of loadtime.
beforeLoad	Holds the current date time, before the onload of the widget.
loadTime	Holds the load time of the widget.