Package org.exoplatform.portal.webui.application

Class UIPortletActionListener

java.lang.Object
org.exoplatform.portal.webui.application.UIPortletActionListener
public class UIPortletActionListener extends Object
May 29, 2006

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    UIPortletActionListener.ChangePortletModeActionListener
    This listener is called when the portlet mode of a portlet has to be changed.
    static class 
    UIPortletActionListener.ChangeWindowStateActionListener
    This listener is called when the portlet portlet window state has to be changed.
    static class 
    UIPortletActionListener.ProcessActionActionListener<S,C extends Serializable,I>
    The process action listener is called when an ActionURL generated by the portlet container has been invoked by the client
    The call is delegated to the portlet container iteself using the method portletContainer.processAction(...).
    static class 
    UIPortletActionListener.ProcessEventsActionListener
    Process Events sent by the portlet API during the processAction() and serverResource() methods defined in Portlet API 2.0 (JSR 286)
    static class 
    UIPortletActionListener.RenderActionListener
    This listener is called when a RenderURL url has been generated by the portlet container.
    static class 
    UIPortletActionListener.ServeResourceActionListener<S,C extends Serializable,I>
    The serveResource() method defined in the JSR 286 specs has several goals: - provide binary output like images to be displayed in the portlet (in the previous spec - JSR 168 - a servlet was needed) - provide text output that does not impact the entire portal rendering, it is for instance usefull when dealing with Javascript to return some JSON structures
    The method delegates the call to the portlet container serverResource method after filling the ResourceInput object with the current request state.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CHANGE_PORTLET_MODE_EVENT
     
    static final String
    CHANGE_WINDOW_STATE_EVENT
     
    protected static org.exoplatform.services.log.Log
    log
     
    static final String
    PORTLET_EVENTS
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    UIPortletActionListener()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static <S, C extends Serializable, I>
    List<javax.portlet.Event>
    processEvent(UIPortlet<S,C> uiPortlet, javax.portlet.Event event)
    This method is called when the javax.portlet.Event is supported by the current portlet stored in the Portlet Caontainer
    The processEvent() method can also generates IPC events and hence the portal itself will call the ProcessEventsActionListener once again
    static void
    setNextMode(UIPortlet uiPortlet, javax.portlet.PortletMode portletMode)
    This method is used to set the next portlet mode if this one needs to be modified because of the incoming request
    static void
    setNextState(UIPortlet uiPortlet, javax.portlet.WindowState state)
    This method is used to set the next portlet window state if this one needs to be modified because of the incoming request
    static void
    setupPublicRenderParams(UIPortlet uiPortlet, Map<String,String[]> requestParams)
    This method is called by the process action and render action listeners, aka during the processDecode() phase of our UI framework
    It goes throughs all the request parameters and add to the public render parameters Map the one that are supported by the targeted portlet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • UIPortletActionListener

      public UIPortletActionListener()

  • Method Details

    • setNextState

      public static void setNextState(UIPortlet uiPortlet, javax.portlet.WindowState state)
      This method is used to set the next portlet window state if this one needs to be modified because of the incoming request

    • setNextMode

      public static void setNextMode(UIPortlet uiPortlet, javax.portlet.PortletMode portletMode)
      This method is used to set the next portlet mode if this one needs to be modified because of the incoming request

    • processEvent

      public static <S, C extends Serializable, I> List<javax.portlet.Event> processEvent(UIPortlet<S,C> uiPortlet, javax.portlet.Event event)
      This method is called when the javax.portlet.Event is supported by the current portlet stored in the Portlet Caontainer
      The processEvent() method can also generates IPC events and hence the portal itself will call the ProcessEventsActionListener once again

    • setupPublicRenderParams

      public static void setupPublicRenderParams(UIPortlet uiPortlet, Map<String,String[]> requestParams)
      This method is called by the process action and render action listeners, aka during the processDecode() phase of our UI framework
      It goes throughs all the request parameters and add to the public render parameters Map the one that are supported by the targeted portlet