You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs@cocoon.apache.org by da...@cocoon.zones.apache.org on 2007/06/07 18:58:06 UTC
[DAISY] Created: WebContinuation

A new document has been created.

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

Document ID: 1389
Branch: main
Language: default
Name: WebContinuation
Document Type: Cocoon Document
Created: 6/7/07 4:57:52 PM
Creator (owner): Reinhard Pötz
State: publish

Parts
=====

Content
-------
Mime type: text/xml
Size: 2034 bytes
Content:
<html>
<body>

<p>A <tt>WebContinuation</tt> represents a continuation of a Flowscript. Because
a user may click on the back button in the browser and restart a saved
computation in a continuation, each <tt>WebContinuation</tt> becomes the parent
of a subtree of continuations.</p>

<p>If there is no parent <tt>WebContinuation</tt>, the created continuation
becomes the root of a tree of <tt>WebContinuation</tt>s.</p>

<p><tt>WebContinuation</tt> objects support the following functions and
properties:</p>

<h3>id</h3>

<p><em>Property</em> <tt>[String] id</tt></p>

<p>Returns the unique string identifier of this Web Continuation.</p>

<h3>continuation</h3>

<p><em>Property</em> <tt>[Continuation] continuation</tt></p>

<p>Returns the JavaScript continuation associated with this Web Continuation.
</p>

<h3>previousBookmark</h3>

<p><em>Property</em> <tt>[WebContinuation] previousBookmark</tt></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>

<h3>isBookmark</h3>

<p><em>Function</em> <tt>[Boolean] isBookmark()</tt></p>

<p>Returns <tt>true</tt> if this continuation was <em>not</em> created by
<a href="#sendPageAndWait">sendPageAndWait</a>.</p>

<h3>getParent</h3>

<p><em>Function</em> <tt>[WebContinuation] getParent()</tt></p>

<p>Get the parent continuation of this continuation.</p>

<h3>getChildren</h3>

<p><em>Function</em> <tt>[Array [WebContinuation]] getChildren()</tt></p>

<p>Get the child continuations of this continuation.</p>

<h3>invalidate</h3>

<p><em>Function</em> <tt>invalidate()</tt></p>

<p>Invalidates a <tt>WebContinuation</tt>. This effectively means that the
continuation object associated with it will no longer be accessible from Web
pages. Invalidating a <tt>WebContinuation</tt> invalidates all the
<tt>WebContinuation</tt>s which are children of it.</p>

</body>
</html>

Collections
===========
The document belongs to the following collections: cdocs-flowscript