[DAISY] Updated: Cocoon Forms: Javascript API

A document has been updated:

http://cocoon.zones.apache.org/daisy/documentation/491.html

Document ID: 491
Branch: main
Language: default
Name: Cocoon Forms: Javascript API (unchanged)
Document Type: Cocoon Document (unchanged)
Updated on: 4/14/08 4:01:51 PM
Updated by: Luca Morandini

A new version has been created, state: draft

Parts
=====

Content
-------
This part has been updated.
Mime type: text/xml (unchanged)
File name:  (unchanged)
Size: 2457 bytes (previous version: 1141 bytes)
Content diff:
(14 equal lines skipped)
    
    <p>TBD</p>
    
--- <h2>Reference</h2>
+++ <h2>Form object reference</h2>
    
+++ <h3>Constructors</h3>
+++ 
    <h4>Form(formDef)</h4>
    
    <p>Is the Formo object cxontructor.</p>
    
    <p><tt>formDef</tt> is the form definition XML, which could be expressed as an
    URI, Source or DOM.</p>
    
+++ <h3>Properties</h3>
+++ 
    <h4>isValid</h4>
    
    <p>Set to true if theuser input has successfily passed validation, false
(7 equal lines skipped)
    
    <p>The form locale (default locale is used if not set).</p>
    
+++ <h4>cleanupHook</h4>
+++ 
+++ <p>It is a function called after having sent the page displaying the form. This
+++ is equivalent to the "fun" argument of sendPageAndWait(), which allows to
+++ perform some cleanup when the pipeline has been processed. The function <br/>
+++ is called with a single parameter which is the form it is attached to.</p>
+++ 
+++ <h4>cleanupHook</h4>
+++ 
+++ <p>It is a function called before processing the form when it has been submitted
+++ by  the browser. This allows to restore some environment that is needed by the
+++ form processing.  The function is called with a single parameter which is the
+++ form it is attached to.</p>
+++ 
+++ <h3>Methods</h3>
+++ 
    <h4>getModel()</h4>
    
    <p>Returns the form as a Widget Java class.</p>
(14 equal lines skipped)
    
    <p>Returns a widget (as a Widget Java class) given its path</p>
    
--- <p><tt>uri</tt> xxx.</p>
+++ <p><tt>uri</tt> the page uri (like in cocoon.sendPageAndWait()).</p>
    
--- <p><tt>viewData</tt> xxx.</p>
+++ <p><tt>viewData</tt> some data for the view (like in cocoon.sendPageAndWait()).
+++ The "{FormsPipelineConfig.CFORMSKEY}" and "locale" properties are added to this
+++ object.</p>
    
--- <p><tt>ttl</tt> xxx.</p>
+++ <p><tt>ttl</tt> the time to live of the continuation used to display the form.
+++ </p>
    
+++ <h4>sendForm </h4>
+++ 
+++ <p>Show form statelessly, without creating a continuation.<br/>
+++ <tt>uri</tt> the page uri (like in cocoon.sendPageAndWait())<br/>
+++ <tt>viewdata</tt> some data for the view (like in cocoon.sendPageAndWait()).</p>
+++ 
+++ <h4>processForm</h4>
+++ 
+++ <p>Process stateless form submit.<br/>
+++ <tt>viewdata</tt> some data for the view (like in cocoon.sendPageAndWait()).</p>
+++ 
    </body>
    </html>