topic Re: Widget Communication Explained in ArcGIS Viewer for Flex Questions

Widget Communication Explained

RobertScheitlin__GISP — Tue, 06 Sep 2011 18:45:47 GMT

All,

I have answered many threads where people are attempting to communicate between widget. So I thought that I would document in detail this previously undocumented portion of the Flex Viewer. In this PDF I explain what happens behind the scenes and provide code examples of what you need to add to your widgets. I also provide code for launching a widget from another widget so you can call a particular public function in the second widget. I hope this helps many.

Re: Widget Communication Explained

NitinBele — Thu, 08 Sep 2011 09:19:01 GMT

Thanks Robert, this is just awasome.
It really had a great insight on Widgets Communication.

Thanks again
Lu.

Re: Widget Communication Explained

FrankRoberts — Mon, 12 Sep 2011 15:32:34 GMT

Thanks Robert! I appreciate the time you put into putting this document together for all of us. It will be a great reference!

Frank

Re: Widget Communication Explained

FrankRoberts — Sat, 11 Dec 2021 07:49:31 GMT

Robert per the document I implemented the code as follows to open up a widget

var id:Number = ViewerContainer.getInstance().widgetManager.getWidgetId(incidentCreateWidget);
    var bWidget:IBaseWidget = ViewerContainer.getInstance().widgetManager.getWidget(id, true) as IBaseWidget;
    if (bWidget){
     var vSW:* = bWidget;
     vSW.queryFromURL("aaa",2,0);     
    }

In the above "incidentCreateWidget" is a string variable that is set from the xml for the widget.

It works great the first time the code is run (I'm running it from a button click event), however on the second time it throws the following error:

ReferenceError: Error #1069: Property queryFromURL not found on widgets.FrEditIncident.FrEditIncidentWidget and there is no default value.

Where "FrEditIncidentWidget" is the widget being called from the first one, where the code resides.

Any ideas?
Frank

Re: Widget Communication Explained

RobertScheitlin__GISP — Wed, 14 Sep 2011 17:28:12 GMT

Frank,

So does the FrEditIncidentWidget have a public function called queryFromURL?

Re: Widget Communication Explained

FrankRoberts — Sat, 11 Dec 2021 07:49:34 GMT

Ok, Got it, your right it doesn't have that function, so of course it would fail. So technically, if I just want to launch another widget, from widget "A" I just need this code:

var id:Number = ViewerContainer.getInstance().widgetManager.getWidgetId("Widget B");
var bWidget:IBaseWidget = ViewerContainer.getInstance().widgetManager.getWidget(id, true) as IBaseWidget;

Then if I want to pass values between the two I just need the following in Widget A:

var msArr:ArrayCollection = new ArrayCollection();
//Add an object or for example a string to the ArrayCollection
msArr.addItem("Text to pass to Widget B");    
addSharedData("MiniSearch_Search", msArr);

And then I can drop this code from Widget A, since I'm not calling a function:

if (bWidget){
var vSW:* = bWidget;
vSW.queryFromURL("aaa",2,0);
}

If I'm wrong feel free to set me straight.

Thanks yet again!

Re: Widget Communication Explained

RobertScheitlin__GISP — Sat, 11 Dec 2021 07:49:37 GMT

Frank,

All is good, but to clarify on the first code block if you are not going to call a public function on the widget than there is no need to get the base widget returned to you.

var id:Number = ViewerContainer.getInstance().widgetManager.getWidgetId("Widget B"); 
AppEvent.dispatch(AppEvent.WIDGET_RUN, id);

The above code is cleaner if you are not calling a function on the widget.

Re: Widget Communication Explained

JamesFaron — Sat, 11 Dec 2021 07:49:39 GMT

Robert,

I am encountering a problem with getting the base widget returned. I have set up function triggered by a checkbox in the Print widget to include the Dynamic Legend. The Dynamic Legend opens as expected, but the code

 if(bWidget)

returns null when I debug, and of course anything after it does not happen. Here is the code I am using

private function incLegend():void
   {
    if(incLgnd.selected)
    {
     var id:Number = ViewerContainer.getInstance().widgetManager.getWidgetId("Dynamic Legend");
     var bWidget:IBaseWidget = ViewerContainer.getInstance().widgetManager.getWidget(id,true) as IBaseWidget;
     if(bWidget){
      var vSW:* = bWidget;
      vSW.exportImage();}

Is there something basic that I am missing?

Thanks,
Jim Faron

Re: Widget Communication Explained

RobertScheitlin__GISP — Wed, 21 Sep 2011 17:13:20 GMT

Jim,

The issue is that if the widget you are calling is not already loaded it takes some time to load and thus the bWidget is going to return null. One way to get around this is to use:

addSharedData("Legend_exportImage", null);

and implement the part of the document under figure 1.

Re: Widget Communication Explained

JamesFaron — Sat, 11 Dec 2021 07:49:42 GMT

Robert,

Thanks for the advice, but I can't seem to get the necessary exchange of data to happen. I added:

private function incLegend():void
   {
    if(incLgnd.selected)
    {
     addSharedData("Legend_exportImage",null);
     var id:Number = ViewerContainer.getInstance().widgetManager.getWidgetId("Dynamic Legend");
     var bWidget:IBaseWidget = ViewerContainer.getInstance().widgetManager.getWidget(id,true) as IBaseWidget;

and then in the Dynamic Legend added:

private function sharedDataUpdated2(event:AppEvent):void
   {
    var dataTable:Hashtable = event.data as Hashtable;
    if(dataTable.containsKey("Legend_exportImage"))
    {
      exportImage();
    }
   }

When I debug, the dataTable key in the SharedDataUpdated2 is null. I fire the event listeners on init in the Dyanamic Legend.

Thanks,
Jim Faron

Re: Widget Communication Explained

RobertScheitlin__GISP — Sat, 11 Dec 2021 07:49:45 GMT

Jim,

Which event listener is calling the sharedDataUpdated2 function and are you calling the fetchSharedData in the init function of the dynamic legend widget?

AppEvent.addListener(AppEvent.DATA_SENT, sharedDataUpdated2);
                fetchSharedData();

Re: Widget Communication Explained

JamesFaron — Sat, 11 Dec 2021 07:49:48 GMT

Robert,

In the Dynamic Legend widget init, I have it as follows:

AppEvent.addListener(AppEvent.DATA_PUBLISH, sharedDataUpdated);
    AppEvent.addListener(AppEvent.DATA_SENT, sharedDataUpdated2);
    fetchSharedData();

Thanks,
Jim Faron

Re: Widget Communication Explained

RobertScheitlin__GISP — Sat, 11 Dec 2021 07:49:51 GMT

Jim,

Sorry about that if the fetchAllData is going to work than we have to actually send something using the addSharedData instead of null.

var msArr:ArrayCollection = new ArrayCollection();
                        msArr.addItem("export");
addSharedData("Legend_exportImage",msArr);

Re: Widget Communication Explained

JamesFaron — Thu, 22 Sep 2011 12:30:30 GMT

Robert,

That was it! Thanks again for all of your help.

Jim Faron

Re: Widget Communication Explained

JamesKo — Fri, 23 Sep 2011 15:17:49 GMT

Hi Robert,

This is has been very helpful but I have another related question. How does one access a variable within a widget from the root application, say index.mxml. I want to save a sharedObject based on a value in a widget.

Thanks in advance.

James

Re: Widget Communication Explained

RobertScheitlin__GISP — Sat, 11 Dec 2021 07:49:53 GMT

James,

I hope that the widget would be loaded already... If that is the case then all you need to do is add these lines to the index.mxml

var id:Number = ViewerContainer.getInstance().widgetManager.getWidgetId("Your Widget");
var bWidget:IBaseWidget = ViewerContainer.getInstance().widgetManager.getWidget(id,true) as IBaseWidget;
x = bWidget.yourPublicVar;

Re: Widget Communication Explained

JamesKo — Fri, 23 Sep 2011 16:28:53 GMT

Robert,

Thanks for the quick response...I was getting the following error message:
Access of possibly undefined property 'myPublicVar' through a reference with static type com.esri.viewer.IBaseWidget.

BUT I just added these lines of code to get it working:

var vSW:* = bWidget;
var whatever:String = vSW.myPublicVar;

Thanks again.

Re: Widget Communication Explained

Anonymous User — Tue, 27 Dec 2011 21:21:34 GMT

Robert -

I found your document on inter-widget communictation very useful. However, I get an odd result when I use the following code in an attempt to toggle 2 widgets:

var Widgetw:IBaseWidget = ViewerContainer.getInstance().widgetManager.getWidget(2, false) as IBaseWidget;

which returns null (as expected) if Widget2 isn't yet open, but the problem is that it ends up launching Widget2 despite the 2nd parameter being set to false. Any ideas?

- Bob

Re: Widget Communication Explained

RobertScheitlin__GISP — Tue, 27 Dec 2011 23:38:18 GMT

Bob,

All the openWidgetIfNot parameter does is if the widget is in a minimized state and the openWidgetIfNot is set to also then it does not set the widgets state to maximized/open.

Re: Widget Communication Explained

Anonymous User — Wed, 28 Dec 2011 19:36:49 GMT

Robert -

Thank you for your quick response. Given that the code block provided seems to end up having the desired result of launching the second widget if it's not already open, is there any other means of toggling 2 widgets visibility that you could recommend? Thanks again for any suggestions you might have.

- Bob