ICEfaces
  1. ICEfaces
  2. ICE-2657

Using Liferay portlet close widget to dynamically remove ICEfaces portlets results in bridge JS error

    Details

    • Type: Task Task
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Invalid
    • Affects Version/s: 1.6
    • Fix Version/s: None
    • Component/s: Bridge
    • Labels:
      None
    • Environment:
      Liferay Portal 4.3.x, ICEfaces portlets in async mode.
    • Affects:
      Compatibility/Configuration
    • Workaround Exists:
      Yes
    • Workaround Description:
      Hide
      There is a viable solution for this as of Liferay 5.1.0 (http://support.liferay.com/browse/LEP-6428).

      To subscribe to the close portlet event you would type:

      Liferay.Publisher.subscribe(
      'closePortlet',
      fn,
      [scope]
      );

      The first parameter is the event that is subscribed, in this case closePortlet. The next parameter is a function that will be executed when the portlet is closed, and the third parameter is option, and it's an object that sets the scope that you wish to execute your Javascript in. So for instance, if you wanted to remap the this object in the function you're passing in, you would pass that object. But of course, it's optional.

      Here is an example of how you would use it:

      Liferay.Publisher.subscribe(
      'closePortlet',
      function (plid, portletId) {
      console.log(plid, portletId);
      }
      );

      Now that the API is available on the client side for disposing of views, the developer can add a version following script to the portlet to enable disposing of a View when the portlet is closed via the portlet window widget. The script id attribute should be unique for each portlet but match the value in the line

      var e = 'id1234'.asElement();


      //Portlet script

              <script id="id1234" type="text/javascript">
                  //this function filters executes the callback function only if the 'e' element is included in the closed portlet
                  //function created to factored into a library
                  function filterEvent(element, callback) {
                      return function(p) {
                          var id = '_' + p.portletId + '_';
                          var parent = element;
                          while (parent) {
                              if (parent.id == id) {
                                  callback();
                                  break;
                              } else {
                                  parent = parent.parentNode;
                              }
                          }
                      }
                  }

                  if (Liferay.Publisher) {
                      var e = 'id1234'.asElement();
                      Liferay.Publisher.subscribe('closePortlet', filterEvent(e, function() {
                          $element(e).findBridge().disposeAndNotify();
                      }));
                  }
              </script>
      Show
      There is a viable solution for this as of Liferay 5.1.0 ( http://support.liferay.com/browse/LEP-6428 ). To subscribe to the close portlet event you would type: Liferay.Publisher.subscribe( 'closePortlet', fn, [scope] ); The first parameter is the event that is subscribed, in this case closePortlet. The next parameter is a function that will be executed when the portlet is closed, and the third parameter is option, and it's an object that sets the scope that you wish to execute your Javascript in. So for instance, if you wanted to remap the this object in the function you're passing in, you would pass that object. But of course, it's optional. Here is an example of how you would use it: Liferay.Publisher.subscribe( 'closePortlet', function (plid, portletId) { console.log(plid, portletId); } ); Now that the API is available on the client side for disposing of views, the developer can add a version following script to the portlet to enable disposing of a View when the portlet is closed via the portlet window widget. The script id attribute should be unique for each portlet but match the value in the line var e = 'id1234'.asElement(); //Portlet script         <script id="id1234" type="text/javascript">             //this function filters executes the callback function only if the 'e' element is included in the closed portlet             //function created to factored into a library             function filterEvent(element, callback) {                 return function(p) {                     var id = '_' + p.portletId + '_';                     var parent = element;                     while (parent) {                         if (parent.id == id) {                             callback();                             break;                         } else {                             parent = parent.parentNode;                         }                     }                 }             }             if (Liferay.Publisher) {                 var e = 'id1234'.asElement();                 Liferay.Publisher.subscribe('closePortlet', filterEvent(e, function() {                     $element(e).findBridge().disposeAndNotify();                 }));             }         </script>

      Description

      This can be reproduced fairly easily. It's an issue with running on Liferay because Liferay supports dynamically adding and removing portlets from the page. What I believe happens is this:

      1) Add an ICEfaces portlet to an empty portal page - just one will do. This causes our JavaScript to be downloaded and executed and the heartbeat to start. Wait for the first successful ping/pong to ensure things are working correctly.

      2) Remove the portlet from the page using the window's close icon (only available on Liferay). Again wait for the ping/pong. In Firebug, you'll see this message:

      [window.0BnX#10.async-connection] receive broadcast failed TypeError: this.elementID.asElement() has no propertiesicefaces-d2d.js (line 1337)

      Our JavaScript bridge + heartbeat is still running. It doesn't get unloaded when the portlet went away. Not even sure that we can detect this in a non-proprietary way.

      This currently won't occur with most of the other portals (like JBoss or Pluto) because to add/remove portlets on those platforms requires you to go to an Admin page of some sort which unloads our page (stopping all the JS). JBoss doesn't give you the option of a close button as a window decoration. Once you're done with the Admin page and go back to the portal page, everything starts fresh so there's no "leftover" JavaScript running.

      We need to discuss this with Liferay to determine the best course of action.

        Issue Links

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              Ken Fyten
            • Votes:
              1 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: