Class Index | File Index

Classes


Class Ozone.state.WidgetStateHandler


Defined in: WidgetStateHandler.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Ozone.state.WidgetStateHandler(widgetEventingController)
This object is used handle widget requests.
Method Summary
Method Attributes Method Name and Description
<static>  
Ozone.state.WidgetStateHandler.getInstance(widgetEventingController)
Retrieves Ozone.eventing.Widget Singleton instance.
 
handleWidgetRequest(config, callback)
handles a widget state request based on the config
Class Detail
Ozone.state.WidgetStateHandler(widgetEventingController)
This object is used handle widget requests. To do so it requires a widgetEventingController
Parameters:
{Ozone.eventing.Widget} widgetEventingController
- widget eventing object which handles eventing for the widget
Deprecated:
Since OWF 3.7.0 You should use Ozone.state.WidgetStateHandler.getInstance
Method Detail
<static> Ozone.state.WidgetStateHandler.getInstance(widgetEventingController)
Retrieves Ozone.eventing.Widget Singleton instance. This object is used handle widget requests. To do so it requires a widgetEventingController
 this.widgetStateHandler = Ozone.state.WidgetStateHandler.getInstance(this.widgetEventingController);
Parameters:
{Ozone.eventing.Widget} widgetEventingController
- widget eventing object which handles eventing for the widget

handleWidgetRequest(config, callback)
handles a widget state request based on the config
//Example for closing a widget
var widgetEventingController = new Ozone.eventing.Widget(Ozone.util.contextPath() + '/js/eventing/rpc_relay.uncompressed.html');
var widgetStateHandler = new Ozone.state.WidgetStateHandler(this.widgetEventingController);
widgetStateHandler.handleStateRequest({
    fn: 'closeWidget',
    params: {
    	guid: 
    }
});
Parameters:
{Object} config
object see example for structure
{Function} callback
a function to be called once after the stateWidget is executed

Documentation generated by JsDoc Toolkit 2.3.2 on Fri Oct 05 2012 16:51:05 GMT-0400 (EDT)