You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by ek...@apache.org on 2005/09/09 19:59:41 UTC
svn commit: r279838 - in
/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui:
databinding.xml datagrid.xml repeater.xml
Author: ekoneil
Date: Fri Sep 9 10:59:36 2005
New Revision: 279838
URL: http://svn.apache.org/viewcvs?rev=279838&view=rev
Log:
Documentation edits sent privately from Krista Baker.
Thanks, Krista!
BB: self
Test: build.release pass
Modified:
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/databinding.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/datagrid.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/repeater.xml
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/databinding.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/databinding.xml?rev=279838&r1=279837&r2=279838&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/databinding.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/databinding.xml Fri Sep 9 10:59:36 2005
@@ -43,9 +43,9 @@
expression text is needed in order to write the tag's name in the HTML rendered to a web browser. For example,
with a <code>userName</code> of "foo", the JSP tag above will render:
</p>
- <source><![CDATA[<input type="text" name="{actionForm.userName}"/> ]]></source>
+ <source><![CDATA[<input type="text" name="{actionForm.userName}" value="foo"/> ]]></source>
<p>
- The expression text is used by the <code>textBox</code> tag to render the value of the HTML <code>input</code>'s
+ The expression text is used by the <code><netui:textBox></code> tag to render the value of the HTML <code>input</code>'s
<code>name</code> attribute, and when the containing HTML form POSTs, this name is used to detect the presence of
a NetUI expression that can then be used to update a property on a JavaBean or other data structure.
</p>
@@ -74,9 +74,9 @@
The JSP container also makes implicit objects available that provide access to the attribute maps for the page context,
request, session, and servlet context. By adding attributes to the page context, request, and session, webapp
developers can add their own implicit objects. In the following example, a JavaBean of type <code>Widget</code> is
- added to the request in a Page Flow action:
+ added to the request in a page flow action:
</p>
- <source>getRequest().setAttribute("widget", fooWidget");</source>
+ <source>getRequest().setAttribute("widget", fooWidget);</source>
<p>
Then, this JSP snippet uses the expression language to data bind to the Widget's <code>density</code> property:
</p>
@@ -156,7 +156,7 @@
object that had <em>page inputs</em> attached to the Forward.
</td>
<td>
- Page flows allow <em>action outputs</em> to be attached to Forward objects as a way to provide a data contract between a Page Flow action
+ Page flows allow <em>action outputs</em> to be attached to Forward objects as a way to provide a data contract between a page flow action
and a page. This ensures that all actions that forward to JSPs provide the JSP with the appropriate data and that all JSPs receive
the correct data. This data contract is validated at both the action and at the JSP when using the
<a href="../apidocs/classref_netui/org/apache/beehive/netui/tags/databinding/pageinput/DeclarePageInput.html">
@@ -171,8 +171,8 @@
page flow</a> which references
<a href="../apidocs/classref_netui/org/apache/beehive/netui/pageflow/SharedFlowController.html">
shared flows</a>.</td>
- <td>The <code>sharedFlow</code> implicit object provides access to any JavaBean properties on Shared Flows assocaited
- with the current page flow. This allows shared flows to expose properties to JSPs.
+ <td>The <code>sharedFlow</code> implicit object provides access to any JavaBean properties on Shared Flows associated
+ with the current page flow. This allows Shared Flows to expose properties to JSPs.
</td>
</tr>
</table>
@@ -186,9 +186,9 @@
<p>
The <code>actionForm</code> implicit object is a convenient way to explicitly reference a JavaBean used for authoring
HTML forms. This implicit object is available only inside of <code><netui:form></code> tags with <code>action</code>
- attributes that reference Page Flow actions accepting a JavaBean. The <code>actionForm</code> implicit object allows
+ attributes that reference page flow actions accepting a JavaBean. The <code>actionForm</code> implicit object allows
data binding to JavaBean properties, Map attributes, Lists, and arrays as with any other implicit object. This example
- shows a JSP that contains a form which POSTs to a Page Flow action that accepts a JavaBean <code>NameForm</code>.
+ shows a JSP that contains a form which POSTs to a page flow action that accepts a JavaBean <code>NameForm</code>.
</p>
<p>The JavaBean:</p>
<source>public class NameForm {
@@ -209,7 +209,7 @@
<netui:button value="Submit"/>
</netui:form>]]></source>
<p>
- The Page Flow action <code>submitNameForm</code>:
+ The page flow action <code>submitNameForm</code>:
</p>
<source>@Jpf.Action()
public Forward submitNameForm(NameForm form) {
@@ -239,7 +239,7 @@
annotation.</li>
</ul>
<p>
- The <code>declareBundle</code> JSP tag is used to make a specific resource bundle avaialble to a JSP. For example,
+ The <code>declareBundle</code> JSP tag is used to make a specific resource bundle available to a JSP. For example,
given the following resource bundle and JSP, a page can data bind to messages in the resource bundle using the
JSP 2.0 EL.
</p>
@@ -310,7 +310,7 @@
</p>
<source>${bundle.jpfBundle.message1}</source>
<p>
- Each of these three ways to register a resource bundle (JSP tag, implicit Page Flow bundle, and explicit Page Flow bundle)
+ Each of these three ways to register a resource bundle (JSP tag, implicit page flow bundle, and explicit page flow bundle)
can be used together in a single page flow.
</p>
</section>
@@ -348,7 +348,7 @@
</li>
</ul>
<p>
- The <code>container</code> implicit object provide access to the current item in the data set and to metadata about the current
+ The <code>container</code> implicit object provides access to the current item in the data set and to metadata about the current
iteration. This access is based on the properties available on the <code>IDataAccessProvider</code> interface and includes:
</p>
<table>
@@ -379,9 +379,9 @@
<source><![CDATA[<%@ taglib uri="http://beehive.apache.org/netui/tags-databinding-1.0" prefix="netui-data"%>
<table>
-<tr><th>Index</th><th>Name</th><th>Name</th></tr>
+<tr><th>Index</th><th>Name</th><th>Density</th></tr>
<netui-data:repeater dataSource="requestScope.widgetBeanArray">
- <tr><td>${container.index}</td><td>${container.item.name}</td><td>${container.item.name}</td></tr>
+ <tr><td>${container.index}</td><td>${container.item.name}</td><td>${container.item.density}</td></tr>
</netui-data:repeater>
</table>]]></source>
<p>
@@ -429,15 +429,15 @@
<title>pageInput</title>
<p>
The <code>pageInput</code> implicit object is used to refer to a <code>Map</code> of objects that are passed via a
- <code>Forward</code> from a Page Flow action to a JSP. Use of Page Inputs consists of two parts -- the first are called
- <em>action outputs</em> and the second are called <em>page inputs</em>. Action outputs are passed from Page Flow actions
- to pages via the action's <code>Forward</code> object. Page Flow actions use Java annotations to declare a validatable
+ <code>Forward</code> from a page flow action to a JSP. Use of Page Inputs consists of two parts -- the first are called
+ <em>action outputs</em> and the second are called <em>page inputs</em>. Action outputs are passed from page flow actions
+ to pages via the action's <code>Forward</code> object. page flow actions use Java annotations to declare a validatable
data contract that ensures that an action passes the correct data via a <code>Forward</code>. At the page, this data
is called a <em>page input</em> and can again be checked to ensure that the page receives the data necessary to render
successfully.
</p>
<p>
- This example shows a Page Flow action that passes an action output of type <code>Widget</code> to a JSP which
+ This example shows a page flow action that passes an action output of type <code>Widget</code> to a JSP which
data binds to the <code>density</code> property on the <code>Widget</code>.
</p>
<p>
@@ -482,7 +482,7 @@
</p>
<p>
Action outputs and page inputs can be used with or without validation; to disable action output validation, simply remove
- any action output annotations from a Page Flow action. To disable page input validation in a JSP, remove any
+ any action output annotations from a page flow action. To disable page input validation in a JSP, remove any
<code>declarePageInput</code> tags from the JSP. The APIs to add action outputs to <code>Forward</code> objects
and to refer to them via the <code>pageInput</code> implicit object will continue to work without any data contract
validation.
@@ -491,14 +491,14 @@
<section id="implicit-objects-netui-sharedFlow">
<title>sharedFlow</title>
<p>
- The <code>sharedFlow</code> implicit object is used to refer to properties of Shared Flow objects that are associated with
+ The <code>sharedFlow</code> implicit object is used to refer to properties of shared flow objects that are associated with
the current page flow. If there is no page flow present, the <code>sharedFlow</code> implicit object will not be available
for data binding. In order for a shared flow to be available for data binding, it must be registered with a page flow by
- type; additionally, it is registered with a name that will uniquely identify it in the set of Shared Flows associated with a
+ type; additionally, it is registered with a name that will uniquely identify it in the set of shared flows associated with a
page flow. More information on shared flows can be found <a href="site:pageflow_sharedFlow">here</a>.
</p>
<p>
- The following example shows a shared flow, a page flow that uses the shared flow, and a JSP that uses the JSP 2.0 EL
+ The following example shows a shared flow, a page flow that uses the Shared Flow, and a JSP that uses the JSP 2.0 EL
to data bind to a JavaBean propety of the shared flow.
</p>
<p>
@@ -538,14 +538,13 @@
</p>
<source><![CDATA[${sharedFlow.aSharedFlow.sharedMessage}]]></source>
<p>
- In a JSP whose current Page Flow controller is the <code>Controller</code> class defined above, the JSP has access to
+ In a JSP whose current page flow controller is the <code>Controller</code> class defined above, the JSP has access to
all of the shared flows associated to the page flow via its
<a href="../apidocs/classref_netui/org/apache/beehive/netui/pageflow/annotations/Jpf.SharedFlowRef.html">
<code>@Jpf.SharedFlowRef</code>
</a>
- annotation. The shared
- flow can then be referenced by the <code>name</code> attribute of the <code>SharedFlowRef</code> annotation. In this case,
- the name <code>aSharedFlow</code> is used in the JSP 2.0 expression to refer to the <code>SharedFlow</code>'s
+ annotation. The shared flow can then be referenced by the <code>name</code> attribute of the <code>SharedFlowRef</code> annotation.
+ In this case, the name <code>aSharedFlow</code> is used in the JSP 2.0 expression to refer to the <code>sharedFlow</code>'s
<code>sharedMessage</code> property.
</p>
</section>
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/datagrid.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/datagrid.xml?rev=279838&r1=279837&r2=279838&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/datagrid.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/datagrid.xml Fri Sep 9 10:59:36 2005
@@ -41,7 +41,7 @@
<p>
The values for the cells are specified with a JSP 2.0 expression and can reference any implicit object. In this case, an
expression like <code>${container.item.petId}</code> references an implicit object called <code>container</code> that the
-<code><netui-data:rows></code> tag provides. This implicit object has a <code>item</code> property that references
+<code><netui-data:rows></code> tag provides. This implicit object has an <code>item</code> property that references
the current item from data set bound to the <code>dataSource</code> attribute of the <code><netui-data:dataGrid></code>
tag.
</p>
@@ -145,8 +145,9 @@
The data grid has three ways to apply styles to the rendered HTML elements including table rows,
cells, captions, and the HTML table itself. By default, the data grid renders a set of HTML
style class names which can be used in conjunction with a user-provided CSS file to automatically
-apply styles to the grid. The default CSS names for various data grid regions are as follows:
-
+apply styles to the grid. The default CSS names for various data grid regions are listed in
+a table below.
+<br/>
In addition, the style information can be customized by the page author in two ways via the
<code>style</code> and <code>styleClass</code> attributes. Many of the data grid tags provide
these attributes and set the HTML <code>style</code> and <code>class</code> attributes on
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/repeater.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/repeater.xml?rev=279838&r1=279837&r2=279838&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/repeater.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/repeater.xml Fri Sep 9 10:59:36 2005
@@ -44,7 +44,7 @@
<netui-data:repeater dataSource="pageSource.todoList">
<li>${container.item.taskName} -- ${container.item.description}</li>
</netui-data:repeater>
-<ul>
+</ul>
]]></source>
<p>
The <code>container</code> implicit object is available for data binding with the JSP 2.0 Expression Language
@@ -125,10 +125,16 @@
The cell repeater is a JSP tag that is used to render the contents of each cell in an HTML table. This user interface
pattern is common in catalogs and shopping carts and is often used to display a single item per cell. The cell
repeater can be constrained to render a table with a fixed length, a fixed width, or both a fixed length and width.
- <!-- For example, the following sample will display a table of PetBean objects, one per cell in a table four cells wide: -->
- <!-- TODO: provide sample code -->
+ For example, the following sample will display a table of PetBean objects, one per cell in a table two cells wide:
</p>
-
+ <source><![CDATA[
+<netui-data:cellRepeater dataSource="pageScope.pets" columns="2">
+ ID: <netui:span value="${container.item.petId}"/><br/>
+ Name: <netui:span value="${container.item.name}"/><br/>
+ Description: <netui:span value="${container.item.description}"/><br/>
+ Price: <netui:span value="${container.item.price}"/><br/>
+</netui-data:cellRepeater>
+ ]]></source>
</section>
</body>
</document>