[MMBASE CVS] src/org/mmbase/framework AbstractRenderer.java Renderer.java

[Michiel Meeuwissen]

Update of /var/cvs/src/org/mmbase/framework
In directory james.mmbase.org:/tmp/cvs-serv694

Modified Files:
        AbstractRenderer.java Renderer.java 
Log Message:
javadoc


See also: http://cvs.mmbase.org/viewcvs/src/org/mmbase/framework


Index: AbstractRenderer.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/AbstractRenderer.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -b -r1.15 -r1.16
--- AbstractRenderer.java       26 Aug 2008 07:48:38 -0000      1.15
+++ AbstractRenderer.java       28 Aug 2008 11:43:56 -0000      1.16
@@ -21,7 +21,7 @@
  * Abstract renderer implementation which implements getType and getBlock.
  *
  * @author Michiel Meeuwissen
- * @version $Id: AbstractRenderer.java,v 1.15 2008/08/26 07:48:38 michiel Exp $
+ * @version $Id: AbstractRenderer.java,v 1.16 2008/08/28 11:43:56 michiel Exp $
  * @since MMBase-1.9
  */
 abstract public class AbstractRenderer implements Renderer {
@@ -52,6 +52,11 @@
         return null;
     }
 
+    /**
+     * This utility method, which of course must be used in conjuction with 
[EMAIL PROTECTED] #decorateOutro}
+     * can be used in concretizations of this class, for easy production of 
the div which is
+     * requested by the contract of a ([EMAIL PROTECTED] Renderer.BODY}) 
renderer for text/html.
+     */
     protected void decorateIntro(RenderHints hints, Writer w, String 
extraClass)  throws IOException {
         w.write("<div id=\"" + hints.getId() + "\"");
         w.write(" class=\"");
@@ -69,9 +74,15 @@
     protected void decorateOutro(RenderHints hints, Writer w) throws 
IOException {
         w.write("</div>");
     }
+    /**
+     * @iniheritDoc
+     *
+     * On default, a renderer has no parameters of itself
+     */
     public Parameter[] getParameters() {
         return new Parameter[] {};
     }
+
     public abstract void render(Parameters blockParameters, Writer w, 
RenderHints hints) throws FrameworkException;
 
 }


Index: Renderer.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/Renderer.java,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -b -r1.22 -r1.23
--- Renderer.java       26 Aug 2008 07:48:38 -0000      1.22
+++ Renderer.java       28 Aug 2008 11:43:56 -0000      1.23
@@ -21,7 +21,7 @@
  * A Renderer is stateless.
  *
  * @author Michiel Meeuwissen
- * @version $Id: Renderer.java,v 1.22 2008/08/26 07:48:38 michiel Exp $
+ * @version $Id: Renderer.java,v 1.23 2008/08/28 11:43:56 michiel Exp $
  * @since MMBase-1.9
  */
 public interface Renderer {
@@ -37,7 +37,9 @@
          */
         HEAD,
        /**
-        * A body typed renderer renders the actual content of a block. It 
should produce a &lt;div&gt;
+        * A body typed renderer renders the actual content of a block. It 
should produce, at least
+        * for text/html, a &lt;div&gt; with class 'mm_c c_&lt;name of 
component&gt; b_&lt; name of
+        * block&gt;
         */
         BODY;
 
_______________________________________________
Cvs mailing list
Cvs@lists.mmbase.org
http://lists.mmbase.org/mailman/listinfo/cvs