Differences between revisions 5 and 6
Revision 5 as of 2007-07-15 11:05:22
Size: 4756
Editor: dialup-4
Comment: Renaming Lenya 1.4 to 2.0
Revision 6 as of 2009-09-20 23:27:53
Size: 4756
Editor: localhost
Comment: converted to 1.6 markup
No differences found!

NOTE: Since version 2.0 it is possible to use cforms in combination with the usecase-fw. The following how to describes the basic steps you need to do.

Create a cform specific usecase handler

Create an usecase like described in http://lenya.apache.org/1_4/reference/usecase-framework/index.html. Instead to use the default usecase handler use something like:

<xconf xpath="/cocoon/usecases" remove="/cocoon/usecases/component-instance[@name = 'example.dynamicrepeater']">
  <component-instance name="example.dynamicrepeater"
    <view template="modules/samples/usecases/dynamicrepeater/dynamicrepeater_template.xml" type="cforms">
      <definition template="modules/samples/usecases/dynamicrepeater/dynamicrepeater.xml">
          form.setAttribute("counter", new java.lang.Integer(0));
      <binding template="modules/samples/usecases/dynamicrepeater/dynamicrepeater_binding.xml">
          generic.doc = Packages.javax.xml.parsers.DocumentBuilderFactory.newInstance().newDocumentBuilder().newDocument();
        saveDocument(generic.doc, generic.proxy.getParameter('sourceUri'));

The important part is @type="cforms" in the <view/> element. This will tell lenya to use the special cform code. Everything inside the <view/> element can be used for custom flow definitions.

Have a look on the usecase.js to see what is going on in detail. We are going to explain the basic concept with the <definition/> and <binding/> element.

 * var generic - Generic object that can be used in all custom flow code
 * that is added by usecases. Right now it focus on document opertations
 *  but the properties should be extended through user/dev feedback.
 * The intention of this var is to provide a generic global flow object
 * (like in lots of cocoon examples) that can be accessed through out the different flow stages.
 * Alternatively one can use the invoking java class by providing bean properties methods 
 * (getter/setter methods) in this class and use them within the extensions (see usecase doc).

You can use the generic variables to store values that you may need in later steps of your custom flow or in the cform.

// form definition                       
form = new Form(viewDef);
// custom flowscript 
if (view.getCformDefinitionBody()!=null){
scriptString= view.getCformDefinitionBody();
evalFunc = new Function ("form","generic",scriptString);

The dynamicRepeater example in cocoon needs a counter to be set in the flow script. {{{<definition template="modules/samples/usecases/dynamicrepeater/dynamicrepeater.xml">

  • form.setAttribute("counter", new java.lang.Integer(0));

</definition>}}} That can be done because we pass the "form" into the dynamic generated function. This way all changes that we may need in our custom flow will be applied to the form.

// form binding
if (view.getCformBinding() != null){
  var viewBind = "fallback://lenya/"+ view.getCformBinding();
  if (cocoon.log.isDebugEnabled())
  cocoon.log.debug("usecases.js::executeUsecase()::cforms in usecase " + usecaseName + ", preparing formDefinition, calling Cocoon with viewUri = [" + viewBind + "]");
// form binding
// custom flowscript 
  if (view.getCformBindingBody()!=null){
    scriptString= view.getCformBindingBody();
    evalFunc = new Function ("form","generic",scriptString);

The binding for the dynamicrepeater example need a document to work. We can use the generic.doc variable to store it and pass it to the binding. This document you may want to save later on in the outro. This could be done with e.g.

  saveDocument(generic.doc, generic.proxy.getParameter('sourceUri'));

The other interesting usage of the the generic variable can be seen here. It is possible to pass variables form your java class usecase to the flow and the cforms.

Document doc = getSourceDocument();
String sourceUri=doc.getSourceURI();
setParameter("sourceUri", sourceUri);

This way you can save the document back if it is invoked by a certain doc.

HowToCFormsInLenya2.0 (last edited 2009-09-20 23:27:53 by localhost)