Update of /var/cvs/src/org/mmbase/framework
In directory james.mmbase.org:/tmp/cvs-serv31005
Modified Files:
Block.java ChainedRenderer.java Component.java
ErrorRenderer.java FrameworkException.java
FrameworkFilter.java JspRenderer.java Processor.java
Renderer.java Setting.java StringRenderer.java
Log Message:
javadoc
See also: http://cvs.mmbase.org/viewcvs/src/org/mmbase/framework
Index: Block.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/Block.java,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -b -r1.28 -r1.29
--- Block.java 16 Nov 2007 11:40:08 -0000 1.28
+++ Block.java 25 Jan 2008 09:32:23 -0000 1.29
@@ -21,7 +21,7 @@
*
* @author Johannes Verelst
* @author Michiel Meeuwissen
- * @version $Id: Block.java,v 1.28 2007/11/16 11:40:08 michiel Exp $
+ * @version $Id: Block.java,v 1.29 2008/01/25 09:32:23 michiel Exp $
* @since MMBase-1.9
*/
public class Block {
@@ -77,7 +77,7 @@
}
/**
- * @todo
+ * @todo This method is not yet implemented.
*/
public Type[] getClassification(String filter) {
String[] parts = filter.split("\\s*?[,\\s]\\s*");
Index: ChainedRenderer.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/ChainedRenderer.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- ChainedRenderer.java 26 Dec 2007 17:07:19 -0000 1.2
+++ ChainedRenderer.java 25 Jan 2008 09:32:23 -0000 1.3
@@ -20,10 +20,12 @@
import org.mmbase.util.logging.Logging;
/**
- * HEAD renderers can be chained, because they don't produce a well defined
block.
+ * This renderer simply calles the methods of a number of other Renderes
sequentially. Only
+ * [EMAIL PROTECTED] Renderer.Type.HEAD} renderers can be chained, because
they don't have to produce a well defined
+ * block.
*
* @author Michiel Meeuwissen
- * @version $Id: ChainedRenderer.java,v 1.2 2007/12/26 17:07:19 michiel Exp $
+ * @version $Id: ChainedRenderer.java,v 1.3 2008/01/25 09:32:23 michiel Exp $
* @since MMBase-1.9
*/
Index: Component.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/Component.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -b -r1.16 -r1.17
--- Component.java 21 Jan 2008 17:29:10 -0000 1.16
+++ Component.java 25 Jan 2008 09:32:23 -0000 1.17
@@ -16,8 +16,10 @@
* A component is a piece of pluggable functionality that typically has
dependencies on other
* components, and may be requested several views.
*
+ * A Component bundles [EMAIL PROTECTED] Block}s, [EMAIL PROTECTED] Action}s
and [EMAIL PROTECTED] @Setting}.
+ *
* @author Michiel Meeuwissen
- * @version $Id: Component.java,v 1.16 2008/01/21 17:29:10 michiel Exp $
+ * @version $Id: Component.java,v 1.17 2008/01/25 09:32:23 michiel Exp $
* @since MMBase-1.9
*/
public interface Component {
Index: ErrorRenderer.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/ErrorRenderer.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -b -r1.8 -r1.9
--- ErrorRenderer.java 16 Nov 2007 13:55:32 -0000 1.8
+++ ErrorRenderer.java 25 Jan 2008 09:32:23 -0000 1.9
@@ -22,11 +22,14 @@
import org.mmbase.util.logging.Logging;
/**
- * If rendering of a block fails, for some reason, that this renderer can be
used in stead, to
+ * If rendering of a block fails, for some reason, then this renderer can be
used in stead, to
* present the error.
*
+ * @todo Its workings are similar to /mmbase/errorpages/500.jsp, and we should
consider that these two
+ * share code.
+ *
* @author Michiel Meeuwissen
- * @version $Id: ErrorRenderer.java,v 1.8 2007/11/16 13:55:32 michiel Exp $
+ * @version $Id: ErrorRenderer.java,v 1.9 2008/01/25 09:32:23 michiel Exp $
* @since MMBase-1.9
*/
Index: FrameworkException.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/FrameworkException.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- FrameworkException.java 8 Dec 2006 16:32:16 -0000 1.2
+++ FrameworkException.java 25 Jan 2008 09:32:23 -0000 1.3
@@ -14,8 +14,9 @@
* such as when rendering or processing a component.
*
* @author Pierre van Rooden
- * @version $Id: FrameworkException.java,v 1.2 2006/12/08 16:32:16 michiel Exp
$
+ * @version $Id: FrameworkException.java,v 1.3 2008/01/25 09:32:23 michiel Exp
$
* @version MMBase-1.9
+ * @todo i18n?
*/
public class FrameworkException extends Exception {
Index: FrameworkFilter.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/FrameworkFilter.java,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -b -r1.18 -r1.19
--- FrameworkFilter.java 16 Nov 2007 18:29:12 -0000 1.18
+++ FrameworkFilter.java 25 Jan 2008 09:32:23 -0000 1.19
@@ -36,7 +36,7 @@
* 'excludes' parameter in web.xml.
*
* @author André van Toly
- * @version $Id: FrameworkFilter.java,v 1.18 2007/11/16 18:29:12 michiel Exp $
+ * @version $Id: FrameworkFilter.java,v 1.19 2008/01/25 09:32:23 michiel Exp $
*/
public class FrameworkFilter implements Filter, MMBaseStarter {
@@ -50,7 +50,7 @@
private Thread initThread;
/**
- * The pattern being used to determine to exlude an URL
+ * The pattern being used to determine to exclude an URL
*/
private static Pattern excludePattern;
Index: JspRenderer.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/JspRenderer.java,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -b -r1.26 -r1.27
--- JspRenderer.java 21 Dec 2007 16:14:34 -0000 1.26
+++ JspRenderer.java 25 Jan 2008 09:32:23 -0000 1.27
@@ -20,10 +20,10 @@
import org.mmbase.util.logging.Logging;
/**
- * A Renderer implmentation based on a jsp.
+ * A Renderer implementation based on a jsp.
*
* @author Michiel Meeuwissen
- * @version $Id: JspRenderer.java,v 1.26 2007/12/21 16:14:34 michiel Exp $
+ * @version $Id: JspRenderer.java,v 1.27 2008/01/25 09:32:23 michiel Exp $
* @since MMBase-1.9
*/
public class JspRenderer extends AbstractRenderer {
Index: Processor.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/Processor.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -b -r1.9 -r1.10
--- Processor.java 30 Jul 2007 16:36:05 -0000 1.9
+++ Processor.java 25 Jan 2008 09:32:23 -0000 1.10
@@ -15,8 +15,11 @@
* A Processor handles interaction of a [EMAIL PROTECTED] Block}. It is like a
[EMAIL PROTECTED] Renderer}, but it renders
* nothing, it only can change the state of the block, and hence influence the
renderers.
*
+ * The other difference is that there be several [EMAIL PROTECTED] Block}s in
a request, which are all
+ * rendered, but at most one of them has its Processor executed.
+ *
* @author Michiel Meeuwissen
- * @version $Id: Processor.java,v 1.9 2007/07/30 16:36:05 michiel Exp $
+ * @version $Id: Processor.java,v 1.10 2008/01/25 09:32:23 michiel Exp $
* @since MMBase-1.9
*/
public interface Processor {
Index: Renderer.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/Renderer.java,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -b -r1.18 -r1.19
--- Renderer.java 6 Aug 2007 16:57:45 -0000 1.18
+++ Renderer.java 25 Jan 2008 09:32:23 -0000 1.19
@@ -15,20 +15,35 @@
/**
* A Renderer renders a certain aspect of a [EMAIL PROTECTED] Block}.
Currently every block has two renderers,
* which are identified by the renderer 'type' (see [EMAIL PROTECTED] #getType
}). Every block also has a
- * [EMAIL PROTECTED] Processor}, which is similar to a Renderer, but a
processor never generates contents, only
+ * [EMAIL PROTECTED] Processor}, which is similar to a Renderer, but a
processor never generates content, only
* handles interaction.
*
* A Renderer is stateless.
*
* @author Michiel Meeuwissen
- * @version $Id: Renderer.java,v 1.18 2007/08/06 16:57:45 michiel Exp $
+ * @version $Id: Renderer.java,v 1.19 2008/01/25 09:32:23 michiel Exp $
* @since MMBase-1.9
*/
public interface Renderer {
+ /**
+ * Every block can be in a certain window state, which could be considered
during rendering.
+ */
enum WindowState {
- MAXIMIZED, MINIMIZED, NORMAL;
+ /**
+ * Rendering may suppose a full browser window
+ */
+ MAXIMIZED,
+ /**
+ * Rendering should suppose only a 'link' version from the component.
+ */
+ MINIMIZED,
+ /**
+ * Rendering may suppose quite a large area, but should be aware that
other blocks are in a
+ * similar state.
+ */
+ NORMAL;
}
enum Type {
Index: Setting.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/Setting.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- Setting.java 6 Aug 2007 16:56:32 -0000 1.3
+++ Setting.java 25 Jan 2008 09:32:23 -0000 1.4
@@ -17,10 +17,15 @@
import org.mmbase.util.logging.Logging;
/**
- * Representation of component related settings.
+ * Representation of component related settings. These settings can be defined
in the component
+ * XML.
+ *
+ * @todo The <em>values</em> of the settings can still only be set in memory
and in the component
+ * xml. There must be some way to persistify them. There should also be a
editor in the admin pages.
+ *
*
* @author Michiel Meeuwissen
- * @version $Id: Setting.java,v 1.3 2007/08/06 16:56:32 michiel Exp $
+ * @version $Id: Setting.java,v 1.4 2008/01/25 09:32:23 michiel Exp $
* @since MMBase-1.9
*/
public class Setting<C> {
@@ -56,6 +61,8 @@
public Component getComponent() {
return parent;
}
+ /**
+ *
public DataType<C> getDataType() {
return dataType;
}
Index: StringRenderer.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/StringRenderer.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -b -r1.8 -r1.9
--- StringRenderer.java 30 Jul 2007 16:36:05 -0000 1.8
+++ StringRenderer.java 25 Jan 2008 09:32:23 -0000 1.9
@@ -18,10 +18,11 @@
import org.mmbase.util.logging.Logging;
/**
- * The overly simple renderer which is simply based on a String present in the
configuration file
+ * The overly simple renderer which is simply based on a String present in the
configuration
+ * file. Based on [EMAIL PROTECTED] PatterNodeFunctionProvider} so several
parameters can be present.
*
* @author Michiel Meeuwissen
- * @version $Id: StringRenderer.java,v 1.8 2007/07/30 16:36:05 michiel Exp $
+ * @version $Id: StringRenderer.java,v 1.9 2008/01/25 09:32:23 michiel Exp $
* @since MMBase-1.9
*/
public class StringRenderer extends AbstractRenderer {
_______________________________________________
Cvs mailing list
[email protected]
http://lists.mmbase.org/mailman/listinfo/cvs
