Return-Path: Delivered-To: apmail-cocoon-cvs-archive@www.apache.org Received: (qmail 97916 invoked from network); 28 Jan 2004 05:48:46 -0000 Received: from daedalus.apache.org (HELO mail.apache.org) (208.185.179.12) by minotaur-2.apache.org with SMTP; 28 Jan 2004 05:48:46 -0000 Received: (qmail 38309 invoked by uid 500); 28 Jan 2004 05:48:24 -0000 Delivered-To: apmail-cocoon-cvs-archive@cocoon.apache.org Received: (qmail 38251 invoked by uid 500); 28 Jan 2004 05:48:24 -0000 Mailing-List: contact cvs-help@cocoon.apache.org; run by ezmlm Precedence: bulk Reply-To: dev@cocoon.apache.org list-help: list-unsubscribe: list-post: Delivered-To: mailing list cvs@cocoon.apache.org Received: (qmail 38219 invoked by uid 500); 28 Jan 2004 05:48:24 -0000 Delivered-To: apmail-cocoon-2.1-cvs@apache.org Received: (qmail 38212 invoked from network); 28 Jan 2004 05:48:24 -0000 Received: from unknown (HELO minotaur.apache.org) (209.237.227.194) by daedalus.apache.org with SMTP; 28 Jan 2004 05:48:24 -0000 Received: (qmail 97514 invoked by uid 1544); 28 Jan 2004 05:48:33 -0000 Date: 28 Jan 2004 05:48:33 -0000 Message-ID: <20040128054833.97513.qmail@minotaur.apache.org> From: coliver@apache.org To: cocoon-2.1-cvs@apache.org Subject: cvs commit: cocoon-2.1/src/documentation/xdocs/userdocs/flow api.xml X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N X-Spam-Rating: minotaur-2.apache.org 1.6.2 0/1000/N coliver 2004/01/27 21:48:33 Modified: src/documentation/xdocs/userdocs/flow api.xml Log: Documented createPageLocal(), createWebContinuation(), and bookmark related properties of WebContinuation 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.

+ +

+ Function [Object] createPageLocal() +

+ Creates a Page Local object. The returned object behaves like a normal JavaScript object, but restores the property values it had when sendPageAndWait 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. +

Function processPipelineTo([String] uri, [Object] bizData, [java.io.OutputStream] stream)

@@ -147,6 +155,28 @@ Send a client-side redirect to the browser. The uri argument is the URI to which the browser should be redirected.

+ +

+ Function [WebContinuation] createWebContinuation() +

+Creates a new "bookmark" WebContinuation 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. +

+ +

For example:

+ + +function processPage() { + + var bkm = cocoon.createWebContinuation(); + var biz = getBizData(); + cocoon.sendPageAndWait("uri", + {bookmark: bkm, biz: biz}, + function() { releaseData(biz); }); +} + +

Function load([String] uri)

@@ -713,6 +743,14 @@

Property [Continuation] continuation

Returns the JavaScript continuation associated with this Web Continuation.

+ + +

Property [WebContinuation] previousBookmark

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.

+ + +

Function [Boolean] isBookmark()

Returns true if this continuation was not created by sendPageAndWait.