Information about a usecase view.
version:
$Id: UsecaseView.java 587463 2007-10-23 11:58:57Z nettings $
version:
version:
Example configuration:
version:
<view uri="/modules/foo/usecases/foo-mogrify.jx"
version:
customFlow="/modules/foo/flow/myflow.js"
version:
menu="false|true"
version:
createContinuation="false|true"
version:
>
version:
<tab group="foo" name="bar"/> // optional
version:
<parameter name="foo" value="bar/> // optional
version:
</view>
version:
version:
version:
uri is the relative URL of the page to be sent back to the client. If the URI
version:
starts with a slash, it is resolved starting at the root sitemap, otherwise it
version:
is resolved relative to the current sitemap. The URI should not contain a
version:
scheme (such as cocoon:).
version:
version:
version:
menu is a boolean that governs whether the Lenya GUI menu is displayed while
version:
the usecase is running. The displaying of the menu is handled by the usecase.xmap sitemap;
version:
hence this option is only functional if uri does not start with a slash
version:
(or if you implement it yourself based on the showMenu() method of this object).
version:
Default is false.
version:
version:
version:
customFlow is a javascript file where you can provide custom methods that will override
version:
those in the default usecase handler (modules-core/usecase/usecases.js).
version:
Currently, it provides support for "customLoopFlow" and "customSubmitFlow". Refer to the default handler
version:
for function prototypes and more information.
version:
NB: the "menu" and "createContinuation" attributes will have no effect when you use custom flow code, unless
version:
you check for them and implement the respective functions yourself.
version:
version:
version:
createContinuation can be set to false, in which case the generic flowscript
version:
uses "sendPage" instead of "sendPageAndWait" and terminates after the view has been sent.
version:
When createContinuation is false, you must not specify submitFlow
version:
or loopFlow.
version:
Default is true.
version:
version:
version:
For tabbed usecases, you can optionally specify a tab group and name. Additional custom
version:
configuration can be passed via the generic "parameter" element.
version:
version:
version:
For backwards compatibility with existing usecases, the constructor looks for a template
version:
attribute if no uri is present. It is mapped to the same field, viewUri, internally.
version:
| 