[portal-commits] JBoss Portal SVN: r8325 - branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event.

Author: julien(a)jboss.com Date: 2007-09-18 12:34:41 -0400 (Tue, 18 Sep 2007) New Revision: 8325 Modified: branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/PageRenderEvent.java branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventListener.java branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/WindowActionEvent.java branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/WindowEvent.java branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/WindowNavigationEvent.java branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/WindowRenderEvent.java Log: update api javadoc for node events. Modified: branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/PageRenderEvent.java =================================================================== --- branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/PageRenderEvent.java 2007-09-18 15:46:53 UTC (rev 8324) +++ branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/PageRenderEvent.java 2007-09-18 16:34:41 UTC (rev 8325) @@ -25,7 +25,7 @@ import org.jboss.portal.api.node.PortalNode; /** - * This event is fired whenever a page is rendered. + * This event is raised whenever a page is rendered. * * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision: 1.1 $ Modified: branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventListener.java =================================================================== --- branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventListener.java 2007-09-18 15:46:53 UTC (rev 8324) +++ branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/PortalNodeEventListener.java 2007-09-18 16:34:41 UTC (rev 8325) @@ -31,11 +31,17 @@ public interface PortalNodeEventListener { /** - * Dispatch an event to the listener. + * <p>Dispatch an event to the listener. If the listener does not care about replacing the current event with a new + * one then it should return the event returned by the <code>PortalNodeEventContext</code> provided such as:</p> * + * <p><code>return context.dispatch()</code></p> + * + * <p>Otherwise it can return a new event to replace the current one. Only events of type <code>WindowNavigationEvent</code> + * or <code>WindowActionEvent;</code> will have an effect.</p> + * * @param context the context in which the event is triggered * @param event the fired event - * @return an possible new events that will replace the current event or null to keep the same event + * @return an event */ PortalNodeEvent onEvent(PortalNodeEventContext context, PortalNodeEvent event); } Modified: branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/WindowActionEvent.java =================================================================== --- branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/WindowActionEvent.java 2007-09-18 15:46:53 UTC (rev 8324) +++ branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/WindowActionEvent.java 2007-09-18 16:34:41 UTC (rev 8325) @@ -27,6 +27,8 @@ import java.util.Map; /** + * This event is raised when the portal invokes an action on a window. + * * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision$ */ Modified: branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/WindowEvent.java =================================================================== --- branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/WindowEvent.java 2007-09-18 15:46:53 UTC (rev 8324) +++ branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/WindowEvent.java 2007-09-18 16:34:41 UTC (rev 8325) @@ -26,7 +26,11 @@ import org.jboss.portal.WindowState; import org.jboss.portal.api.node.PortalNode; -/** @author <a href="mailto:julien@jboss.org">Julien Viet</a> */ +/** + * Base class for window events. + * + * @author <a href="mailto:julien@jboss.org">Julien Viet</a> + */ public abstract class WindowEvent extends PortalNodeEvent { Modified: branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/WindowNavigationEvent.java =================================================================== --- branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/WindowNavigationEvent.java 2007-09-18 15:46:53 UTC (rev 8324) +++ branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/WindowNavigationEvent.java 2007-09-18 16:34:41 UTC (rev 8325) @@ -27,6 +27,8 @@ import java.util.Map; /** + * This event happens when the portal udpates the navigational state of a window. + * * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision$ */ Modified: branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/WindowRenderEvent.java =================================================================== --- branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/WindowRenderEvent.java 2007-09-18 15:46:53 UTC (rev 8324) +++ branches/JBoss_Portal_Branch_2_6/api/src/main/org/jboss/portal/api/node/event/WindowRenderEvent.java 2007-09-18 16:34:41 UTC (rev 8325) @@ -27,6 +27,8 @@ import java.util.Map; /** + * This event occurs when the portal renders a window. + * * @author <a href="mailto:julien@jboss.org">Julien Viet</a> * @version $Revision$ */