cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject cvs commit: cocoon-2.1/src/documentation/xdocs/userdocs/flow api.xml
Date Wed, 28 Jan 2004 05:48:33 GMT
coliver     2004/01/27 21:48:33

  Modified:    src/documentation/xdocs/userdocs/flow api.xml
  Documented createPageLocal(), createWebContinuation(), and bookmark related properties of
  Revision  Changes    Path
  1.32      +38 -0     cocoon-2.1/src/documentation/xdocs/userdocs/flow/api.xml
  Index: api.xml
  RCS file: /home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/flow/api.xml,v
  retrieving revision 1.31
  retrieving revision 1.32
  diff -u -r1.31 -r1.32
  --- api.xml	10 Jan 2004 00:04:37 -0000	1.31
  +++ api.xml	28 Jan 2004 05:48:33 -0000	1.32
  @@ -129,6 +129,14 @@
        Sends an empty response with the provided HTTP status code.
  +    <s3 title = "createPageLocal"><anchor id="createPageLocal"/>
  +      <p>
  +      <em>Function</em> <code>[Object] createPageLocal()</code>
  +      </p>
  +      <p>
  +      Creates a <em>Page Local</em> object. The returned object behaves like
a normal JavaScript object, but restores the property values it had when <link href="#sendPageAndWait">sendPageAndWait</link>
was originally called, each time a page is resubmitted (e.g. after hitting the back button).
Such objects can be used to associate state with one particular page sent to the browser.
  +      </p>
  +    </s3>
       <s3 title="processPipelineTo">
       <em>Function</em> <code>processPipelineTo([String] uri, [Object]
bizData, [] stream)</code></p>
  @@ -147,6 +155,28 @@
         Send a client-side redirect to the browser. The <code>uri</code> argument
is the URI to which the browser should be redirected.
  +    <s3 title = "createWebContinuation"><anchor id="createWebContinuation"/>
  +      <p>
  +      <em>Function</em> <code>[WebContinuation] createWebContinuation()</code>
  +      </p>
  +      <p>
  +Creates a new "bookmark" <link href="#WebContinuation">WebContinuation</link>
object. When invoked it will cause the script to resume right after the call. By calling this
function prior to sendPageAndWait() you can be create a "bookmark" which will cause the page
to be redisplayed in the browser. Note: the WebContinuation associated with sendPageAndWait()
doesn't do this. Rather it resumes execution after the the page is submitted.
  +<p>For example:</p>
  +function processPage() {
  +  var bkm = cocoon.createWebContinuation();
  +  var biz = getBizData();
  +  cocoon.sendPageAndWait("uri", 
  +                         {bookmark: bkm, biz: biz}, 
  +                         function() { releaseData(biz); });
  +    </s3>
       <s3 title="load">
       <p><em>Function</em> <code>load([String] uri)</code></p>
  @@ -713,6 +743,14 @@
       <s3 title="continuation">
       <p><em>Property</em> <code>[Continuation] continuation</code></p>
       <p>Returns the JavaScript continuation associated with this Web Continuation.</p>
  +    </s3>
  +    <s3 title="previousBookmark">
  +    <p><em>Property</em> <code>[WebContinuation] previousBookmark</code></p>
  +    <p>Returns a reference to the first bookmark continuation among the pages preceding
the one associated with this object, or null if no such bookmark continuation exists. The
returned object is the continuation you would invoke to implement a "Back" button.</p>
  +    </s3>
  +    <s3 title="isBookmark">
  +    <p><em>Function</em> <code>[Boolean] isBookmark()</code></p>
  +    <p>Returns <code>true</code> if this continuation was <em>not</em>
created by <link href="#sendPageAndWait">sendPageAndWait</link>.</p>
       <s3 title="getParent">

View raw message