Author: rich
Date: Sun May 22 14:25:45 2005
New Revision: 171373
URL: http://svn.apache.org/viewcvs?rev=171373&view=rev
Log:
Doc updates, mainly for JSF, with some additional minor edits.
tests: validate in docs/forrest (WinXP)
BB: self (linux)
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/index.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jpf-annotations/pageflow_annotations.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jsf.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_overview.xml
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/index.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/index.xml?rev=171373&r1=171372&r2=171373&view=diff
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/index.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/index.xml
Sun May 22 14:25:45 2005
@@ -15,10 +15,11 @@
the coding necessary for J2EE. The initial
Beehive project has
three pieces.</p>
<ul>
- <li>NetUI PageFlows – A web application
framework built
- on top of Struts allowing easier
tooling as well as
- automatic updating of Struts
configuration files with the
- use of metadata.</li>
+ <li>NetUI Page Flow – An annotation-driven web
application framework built
+ on Struts that centralizes navigation
logic/metadata/state in <em>reusable,
+ encapsulated</em> "page flow" controller classes. It
provides an integrated
+ set of JSP tags, as well as first-class integration with
JavaServer Faces and
+ with raw Struts.</li>
<li> Controls – Lightweight component
framework that
helps programmers build components that
incorporate
metadata into their programming model.
This project comes
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jpf-annotations/pageflow_annotations.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jpf-annotations/pageflow_annotations.xml?rev=171373&r1=171372&r2=171373&view=diff
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jpf-annotations/pageflow_annotations.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jpf-annotations/pageflow_annotations.xml
Sun May 22 14:25:45 2005
@@ -5,6 +5,18 @@
<title>Page Flow Annotations</title>
</header>
<body>
+ <section id="desc">
+ <title>Description</title>
+ <p>
+ These annotations configure elements of a Page Flow web
application: page flows, shared flows, etc.
+ All Page Flow annotations come from the annotation interface
+ <a
href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.html">
+ org.apache.beehive.netui.pageflow.annotations.Jpf
+ </a>. To use any of these annotations, include the following
import statement in your source file:
+ </p>
+ <source>import
org.apache.beehive.netui.pageflow.annotations.Jpf</source>
+ </section>
+
<section>
<title>Page Flow Annotations</title>
<p><a
href="../../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.Action.html">@Jpf.Action</a></p>
@@ -2357,4 +2369,4 @@
© 2004, Apache Software Foundation
</legal>
</footer>
-</document>
\ No newline at end of file
+</document>
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jsf.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jsf.xml?rev=171373&r1=171372&r2=171373&view=diff
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jsf.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/jsf.xml
Sun May 22 14:25:45 2005
@@ -5,21 +5,53 @@
<title>Java Server Faces</title>
</header>
<body>
+ <section>
+ <title>Introduction</title>
+ <p>
+ <a href="http://java.sun.com/j2ee/javaserverfaces/";>JavaServer
Faces</a> is
+ technology for building web application user interfaces. It
allows development of
+ very rich component- and event-based pages. Page Flow treats
treats JSF pages as
+ <em>first-class citizens</em>. In addition to allowing the
use of "straight" JSF
+ features, it integrates in the following ways:
+ </p>
+ <ul>
+ <li>When a JSF page is hit, either directly or from a Page
Flow action, an
+ associated "backing bean" class is looked up. If it
exists, an instance is
+ created and managed by the framework. This bean can
contain JSF component
+ references, event handlers, etc., and it can <em>raise
Page Flow actions</em>,
+ with or without form beans attached. Its lifetime is tied
to the lifetime of
+ the JSF page.
+ </li>
+ <li>
+ Componenents in JSF pages can also raise Page Flow actions
directly, with or
+ without form beans attached, using the built-in
<code>action</code> attribute.
+ </li>
+ <li>
+ Pages can databind to Page Flow objects using JSF-style
expressions like
+ <code>#{pageFlow.someProperty}</code> or
+ <code>#{pageInput.somePageInput.someProperty}</code>.
+ </li>
+ <li>
+ A page can databind to properties in its associated
backing bean through a
+ "backing" context, e.g.,
<code>#{backing.someProperty}</code>.
+ </li>
+ <li>When returning to a JSF page through the
+ <a
href="../apidocs/classref_pageflows/org/apache/beehive/netui/pageflow/annotations/Jpf.Forward.html#navigateTo%28%29">navigateTo</a>
+ feature, the page's component tree and its backing bean
are restored.
+ </li>
+ </ul>
+ <p>
+ The <a class="jump"
href="sample_jpf_jsf_integration.html">Page Flow / JSF Sample</a>
+ demonstrates these features.
+ </p>
+
+ </section>
+
<section><title>Enabling Java Server Faces</title>
<p>To enable Java Server Faces in a Beehive web application, complete the
following steps:</p>
<section><title>Integrate JSF Tags in Your Web App</title>
<p>Integrate JSF into your webapp. You can use either <a
href="http://www.marinschek.com/myfaces/tiki/tiki-index.php?page=GettingStarted";><code>MyFaces</code></a>
or
the <a href="http://java.sun.com/j2ee/javaserverfaces/download.html";>JSF
Reference Implementation</a>.</p>
-
-<p>JSF pages and backing classes can</p>
-<ul><li>raise Page Flow actions (with or
-without attached form beans)</li>
- <li>databind to Page Flow objects using expressions like
-"#{pageFlow.foo}"</li>
-</ul>
-<p>Also note that the component tree is preserved when you return to a
-JSF page through <code>[EMAIL PROTECTED]</code>.
- </p>
</section>
<section><title>Configure Your Web Application</title>
<p>Add the following snippet to your <code>WEB-INF/faces-config.xml</code>
file:</p>
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_overview.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_overview.xml?rev=171373&r1=171372&r2=171373&view=diff
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_overview.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_overview.xml
Sun May 22 14:25:45 2005
@@ -9,18 +9,18 @@
<title>Introduction</title>
<p>
- A Java Page Flow (<strong>JPF</strong>) is a group of Java Server Pages
(<strong>JSP</strong>) and a Java class that
- controls the user experience flow through an application. In addition to
allowing
+ A Java Page Flow (<strong>JPF</strong>) is a group of pages (often
JavaServer Pages - <strong>JSPs</strong>)
+ and an annotated Java "controller" class that defines the flow of an
application. In addition to allowing
complex logic to dictate which pages are displayed, JPF technology helps
decouple
- page authoring from application logic by preventing one JSP from directly
referencing
- another. It also allows for easy state management within a single Java
class.
+ page authoring from application logic by preventing one page from directly
referencing
+ another. It also allows for easy state management, and reuse of entire
flows within other flows.
</p>
</section>
<section id="Page_Flow_Features">
<title>Page Flow Features</title>
<p>Page Flows make building Java web applications easy and
intuitive.
- When programming with Page Flows, the developer
writes JAVA classes and JSP pages--that's it.
+ When programming with Page Flows, the developer
writes Java classes and pages --that's it.
There is very little occasion to work with
configuration files, or other components.
Page Flow programming also excels at separating
presentation logic from data processing
logic, resulting in uncluttered JSP code which
is easy to understand and edit.
@@ -196,7 +196,7 @@
</p>
<ul>
- <li>navigate the user to a specified JSP page</li>
+ <li>navigate the user to a specified JSP</li>
<li>perform conditional logic</li>
<li>handle submitted data</li>
<li>validate submitted data</li>
Modified:
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
URL:
http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml?rev=171373&r1=171372&r2=171373&view=diff
==============================================================================
---
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
(original)
+++
incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml
Sun May 22 14:25:45 2005
@@ -92,7 +92,7 @@
</system-controls>
<netui label="Page Flows">
<netui_taglib label="<netui> Tags"
href="apidocs/taglib/index.html"/>
- <netui_annotations label="@Jpf Annotations"
href="pageflow/jpf-annotations/pageflow_annotations.html"/>
+ <netui_annotations label="Page Flow Annotations"
href="pageflow/jpf-annotations/pageflow_annotations.html"/>
<netui_config label="beehive-netui-config.xml"
href="pageflow/config/beehive-netui-config.html"/>
<netui_api label="Page Flow Javadoc"
href="apidocs/classref_pageflows/index.html"/>
</netui>
