Update of /var/cvs/src/org/mmbase/framework
In directory james.mmbase.org:/tmp/cvs-serv5414
Modified Files:
AbstractRenderer.java Component.java RenderHints.java
Utils.java VirtualComponent.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.16
retrieving revision 1.17
diff -u -b -r1.16 -r1.17
--- AbstractRenderer.java 28 Aug 2008 11:43:56 -0000 1.16
+++ AbstractRenderer.java 4 Sep 2008 21:20:01 -0000 1.17
@@ -21,7 +21,7 @@
* Abstract renderer implementation which implements getType and getBlock.
*
* @author Michiel Meeuwissen
- * @version $Id: AbstractRenderer.java,v 1.16 2008/08/28 11:43:56 michiel Exp $
+ * @version $Id: AbstractRenderer.java,v 1.17 2008/09/04 21:20:01 michiel Exp $
* @since MMBase-1.9
*/
abstract public class AbstractRenderer implements Renderer {
@@ -55,7 +55,7 @@
/**
* 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.
+ * requested by the contract of a ([EMAIL PROTECTED] Renderer.Type#BODY})
renderer for text/html.
*/
protected void decorateIntro(RenderHints hints, Writer w, String
extraClass) throws IOException {
w.write("<div id=\"" + hints.getId() + "\"");
@@ -75,7 +75,7 @@
w.write("</div>");
}
/**
- * @iniheritDoc
+ * @inheritDoc
*
* On default, a renderer has no parameters of itself
*/
Index: Component.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/Component.java,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -b -r1.21 -r1.22
--- Component.java 14 Aug 2008 20:19:26 -0000 1.21
+++ Component.java 4 Sep 2008 21:20:02 -0000 1.22
@@ -16,10 +16,10 @@
* A component is a piece of pluggable functionality that typically has
dependencies on other
* components.
*
- * A Component bundles [EMAIL PROTECTED] Block}s, [EMAIL PROTECTED] Action}s
and [EMAIL PROTECTED] Setting}.
+ * A Component bundles [EMAIL PROTECTED] Block}s, [EMAIL PROTECTED] Action}s
and [EMAIL PROTECTED] Setting}s.
*
* @author Michiel Meeuwissen
- * @version $Id: Component.java,v 1.21 2008/08/14 20:19:26 michiel Exp $
+ * @version $Id: Component.java,v 1.22 2008/09/04 21:20:02 michiel Exp $
* @since MMBase-1.9
*/
public interface Component {
@@ -52,7 +52,12 @@
Collection<VirtualComponent> getUnsatisfiedDependencies();
/**
- * Used during bootstrapping. See also [EMAIL PROTECTED]
#getUnsatisfiedDependencies()}
+ * Used during bootstrapping. Marks an unsatisfied dependency as
satisfied. Moves object from
+ * the result of [EMAIL PROTECTED] #getUnsatisfiedDependencies} to [EMAIL
PROTECTED] #getDependencies}.
+ *
+ * @param unsatified The VirtualComponent object that used to be
unsatisfied
+ * @param satisfied The object representing the same component, but now
as an actual Component.
+ *
*/
void resolve(VirtualComponent unsatified, Component satisfied);
Index: RenderHints.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/RenderHints.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- RenderHints.java 26 Aug 2008 06:45:36 -0000 1.1
+++ RenderHints.java 4 Sep 2008 21:20:02 -0000 1.2
@@ -17,7 +17,7 @@
* implementation some instructions about how to render excactly, since it may
vary a bit in that.
*
* @author Michiel Meeuwissen
- * @version $Id: RenderHints.java,v 1.1 2008/08/26 06:45:36 michiel Exp $
+ * @version $Id: RenderHints.java,v 1.2 2008/09/04 21:20:02 michiel Exp $
* @since MMBase-1.9
*/
public class RenderHints {
@@ -34,17 +34,31 @@
this.clazz = clazz;
}
-
+ /**
+ * The renderer where these hints are hinting for.
+ */
public Renderer getRenderer() {
return renderer;
}
+ /**
+ * The window state is a hint on how big a part the rendering can take of
the available
+ * area. Thins like [EMAIL PROTECTED] WindowState#MAXIMIZED} or [EMAIL
PROTECTED] WindowState#NORMAL}.
+ */
public WindowState getWindowState() {
return state;
}
+ /**
+ * A string which can identify the returned rendition in the current
request. This can e.g. be
+ * used to fill an 'id' attribute of the outermost produced XML tag.
+ */
public String getId() {
return id;
}
+
+ /**
+ * The framework may request to add a class for styling to the outermost
produced XML tag.
+ */
public String getStyleClass() {
return clazz;
}
Index: Utils.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/Utils.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- Utils.java 4 Sep 2008 05:56:23 -0000 1.4
+++ Utils.java 4 Sep 2008 21:20:02 -0000 1.5
@@ -20,8 +20,10 @@
import org.mmbase.util.logging.Logging;
/**
+ * Static utilitiy methods which are related to (combine functionality of)
other classes in the packages.
+ *
* @author Michiel Meeuwissen
- * @version $Id: Utils.java,v 1.4 2008/09/04 05:56:23 michiel Exp $
+ * @version $Id: Utils.java,v 1.5 2008/09/04 21:20:02 michiel Exp $
* @since MMBase-1.9
*/
public abstract class Utils {
@@ -31,6 +33,10 @@
// this class has no instances
}
+ /**
+ * Renders a [EMAIL PROTECTED] Renderer} into a new [EMAIL PROTECTED]
Document}. This assumes that the renderer
+ * indeed produces XML. This is e.g. used to include blocks into
editwizard task XML's.
+ */
public static Document renderToXml(Framework fw, Renderer renderer,
Parameters blockParameters, Parameters frameworkParameters, WindowState state,
Class<?> baseClass) throws
FrameworkException {
boolean validation = true;
Index: VirtualComponent.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/VirtualComponent.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -b -r1.6 -r1.7
--- VirtualComponent.java 14 Aug 2008 20:19:26 -0000 1.6
+++ VirtualComponent.java 4 Sep 2008 21:20:02 -0000 1.7
@@ -11,10 +11,11 @@
import org.mmbase.util.logging.*;
/**
- * A Virtual Component is a component which is only mentioned as a dependency
of another component.
+ * A Virtual Component is a component which is only mentioned as a dependency
of another [EMAIL PROTECTED]
+ * Component}. See [EMAIL PROTECTED] Component#getUnsatisfiedDependencies}.
*
* @author Michiel Meeuwissen
- * @version $Id: VirtualComponent.java,v 1.6 2008/08/14 20:19:26 michiel Exp $
+ * @version $Id: VirtualComponent.java,v 1.7 2008/09/04 21:20:02 michiel Exp $
* @since MMBase-1.9
*/
public class VirtualComponent {
_______________________________________________
Cvs mailing list
[email protected]
http://lists.mmbase.org/mailman/listinfo/cvs
