10:39 a.m.
Author: chris.laprun(a)jboss.com
Date: 2009-01-26 11:39:48 -0500 (Mon, 26 Jan 2009)
New Revision: 12641
Modified:
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/client/PresentationClient.java
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model/UINode.java
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model/UIObjectContext.java
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model/ViewPortScope.java
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/ProtocolAction.java
Log:
- Some javadoc updates.
Modified:
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/client/PresentationClient.java
===================================================================
---
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/client/PresentationClient.java 2009-01-26
16:28:32 UTC (rev 12640)
+++
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/client/PresentationClient.java 2009-01-26
16:39:48 UTC (rev 12641)
@@ -22,16 +22,17 @@
******************************************************************************/
package org.jboss.portal.presentation.client;
+import org.jboss.portal.common.servlet.URLFormat;
import org.jboss.portal.presentation.protocol.ProtocolAction;
import org.jboss.portal.presentation.state.navigational.NavigationalStateContext;
import org.jboss.portal.web.ServletContextDispatcher;
-import org.jboss.portal.common.servlet.URLFormat;
import java.io.IOException;
import java.io.Writer;
/**
- * The contract that defines the services that the client provides to the server during a
presentation server invocation.
+ * The contract that defines the services that the client provides to the server during a
presentation server
+ * invocation.
*
* @author <a href="mailto:julien@jboss-portal.org">Julien
Viet</a>
* @version $Revision: 630 $
@@ -40,7 +41,7 @@
{
/**
- * Renders the provided action as an hyperlink.
+ * Renders the provided action as a hyperlink.
*
* @param action the action to render
* @param format the url format
@@ -50,13 +51,13 @@
String renderURL(ProtocolAction action, URLFormat format) throws
IllegalArgumentException;
/**
- * Renders the provided action as an hyperlink.
+ * Renders the provided action as a hyperlink.
*
* @param writer the writer
* @param action the action to render
* @param format the url format
* @throws IllegalArgumentException if the action is null or cannot be rendered
- * @throws IOException any IOException thrown by the writer
+ * @throws IOException any IOException thrown by the writer
*/
void renderURL(Writer writer, ProtocolAction action, URLFormat format) throws
IOException;
Modified:
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model/UINode.java
===================================================================
---
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model/UINode.java 2009-01-26
16:28:32 UTC (rev 12640)
+++
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model/UINode.java 2009-01-26
16:39:48 UTC (rev 12641)
@@ -27,7 +27,7 @@
import java.util.Collection;
/**
- * The node interface provides a pull style api for interacting with an ui object.
+ * The node interface provides a pull style API for interacting with a UI object.
*
* @author <a href="mailto:julien@jboss-portal.org">Julien
Viet</a>
* @version $Revision: 630 $
@@ -36,15 +36,15 @@
{
/**
- * Returns the related ui object.
+ * Returns the related UI object.
*
- * @return the ui object
+ * @return the UI object
*/
UIObject getObject();
/**
- * Returns the parent node or null if it cannot be loaded (because it is the root or
- * because the viewport scope does not go beyond)
+ * Returns the parent node or null if it cannot be loaded (because it is the root or
because the viewport scope does
+ * not go beyond)
*
* @return the parent node
*/
Modified:
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model/UIObjectContext.java
===================================================================
---
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model/UIObjectContext.java 2009-01-26
16:28:32 UTC (rev 12640)
+++
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model/UIObjectContext.java 2009-01-26
16:39:48 UTC (rev 12641)
@@ -28,7 +28,7 @@
import java.util.Map;
/**
- * The context of a a ui object with respect to the viewport.
+ * The context of a UI object with respect to the viewport.
*
* @author <a href="mailto:julien@jboss-portal.org">Julien
Viet</a>
* @version $Revision: 630 $
Modified:
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model/ViewPortScope.java
===================================================================
---
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model/ViewPortScope.java 2009-01-26
16:28:32 UTC (rev 12640)
+++
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/model/ViewPortScope.java 2009-01-26
16:39:48 UTC (rev 12641)
@@ -25,9 +25,9 @@
import org.jboss.portal.presentation.state.structural.StructuralObject;
/**
- * Defines the scope of a viewport. This interface is separated from the viewport context
in order to
- * really affirm the split between the concern between the scope implementation that is
used by the viewport
- * to populate the viewport context during a refresh operation.
+ * Defines the scope of a viewport. This interface is separated from the viewport context
in order to really affirm the
+ * split between the concern between the scope implementation that is used by the
viewport to populate the viewport
+ * context during a refresh operation.
*
* @author <a href="mailto:julien@jboss-portal.org">Julien
Viet</a>
* @version $Revision: 630 $
@@ -42,16 +42,16 @@
String getRootId();
/**
- * Returns how the object should be traversed.
+ * Decides how the specified object should be traversed.
*
* @param object the object
- * @return true if it should be visited
+ * @return an {@link org.jboss.portal.presentation.model.ObjectTraversalType}
representing how the specified object
+ * should be traversed
*/
ObjectTraversalType enterObject(StructuralObject object);
/**
- * Callback to signal that an object visit is terminated. It can be used by the scope
to maintain a data
- * structure of the traversed model.
+ * Signals that the traversal of the specified object is done. Used to maintain proper
traversal state.
*
* @param object the object
*/
Modified:
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/ProtocolAction.java
===================================================================
---
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/ProtocolAction.java 2009-01-26
16:28:32 UTC (rev 12640)
+++
modules/presentation/trunk/presentation/src/main/java/org/jboss/portal/presentation/protocol/ProtocolAction.java 2009-01-26
16:39:48 UTC (rev 12641)
@@ -29,5 +29,5 @@
* @author <a href="mailto:julien@jboss.org">Julien Viet</a>
*/
public abstract class ProtocolAction
-{
+{
}