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/05/11 04:22:47 UTC
svn commit: r169561 - in
/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui:
databinding/datagrid/api/ databinding/datagrid/api/filter/
databinding/datagrid/runtime/config/ databinding/datagrid/runtime/sql/
databinding/datagrid/runtime/util/ tags/databinding/bundle/
tags/databinding/cellrepeater/ tags/databinding/invoke/
tags/databinding/message/ tags/databinding/pageinput/
tags/databinding/repeater/ tags/databinding/script/
Author: ekoneil
Date: Tue May 10 19:22:46 2005
New Revision: 169561
URL: http://svn.apache.org/viewcvs?rev=169561&view=rev
Log:
NetUI Javadoc fixes.
Should resolve JIRA 685.
There are some partially documented classes here; apologies. Just want to get this incrementally checked in.
BB: self
DRT: NetUI pass
BVT: NetUI pass
Modified:
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/DataGridConfig.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/filter/Filter.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/config/DefaultDataGridConfig.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/config/DefaultDataGridStateCodec.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/sql/SQLSupport.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/util/JspFunctions.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/bundle/DeclareBundle.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/cellrepeater/CellRepeater.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/invoke/CallMethod.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/invoke/CallPageFlow.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/message/Message.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/pageinput/DeclarePageInput.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/Repeater.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/RepeaterFooter.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/RepeaterHeader.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/RepeaterItem.java
incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/script/GetData.java
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/DataGridConfig.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/DataGridConfig.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/DataGridConfig.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/DataGridConfig.java Tue May 10 19:22:46 2005
@@ -22,8 +22,8 @@
import org.apache.beehive.netui.databinding.datagrid.api.sort.Sort;
import org.apache.beehive.netui.databinding.datagrid.api.sort.SortModel;
-import org.apache.beehive.netui.databinding.datagrid.api.filter.Filter;
import org.apache.beehive.netui.databinding.datagrid.api.filter.FilterModel;
+import org.apache.beehive.netui.databinding.datagrid.api.filter.Filter;
import org.apache.beehive.netui.databinding.datagrid.api.pager.PagerModel;
import org.apache.beehive.netui.databinding.datagrid.api.rendering.PagerRenderer;
import org.apache.beehive.netui.databinding.datagrid.api.rendering.StyleModel;
@@ -31,11 +31,11 @@
/**
* <p>
* Abstract class used by the data grid to create model objects used for state
- * management and rendering. This abstraction exists in order to all the data grid's
- * implementation to be configurable. Various data grid features are exposed here including
- * sorting, filtering, and paging. In addition, classes such as the {@link PagerRenderer} and
- * {@link StyleModel} are created by subclasses in order to provide a data grid specific
- * implementation of pager UI or style support.
+ * management and rendering. This abstraction exists in order to allow the data grid's
+ * implementation to be configurable. Various data grid implementation classes are exposed
+ * here including sorting, filtering, and paging. In addition, classes such as the
+ * {@link PagerRenderer} and {@link StyleModel} are created by subclasses in order to provide
+ * a data grid specific implementation of pager UI or style support.
* </p>
* <p>
* By default, DataGridConfig implementations are not thread safe, but custom implementations are
@@ -52,12 +52,42 @@
public abstract class DataGridConfig
implements java.io.Serializable {
+ /**
+ * <p>
+ * Create a {@link DataGridState} instance that will be used to store the state for a data grid. This
+ * method will be called only when a DataGridState object needs to be manufactured by a data grid tag.
+ * </p>
+ *
+ * @return the {@link DataGridState} object for a data grid.
+ */
public abstract DataGridState createDataGridState();
+ /**
+ * <p>
+ * Create a concrete {@link Sort} implementation for a data grid. When the sort state of a data grid
+ * is created, this {@link Sort} instance will contain a single sort.
+ * </p>
+ * @return a {@link Sort} instance
+ */
public abstract Sort createSort();
+ /**
+ * <p>
+ * Create a concrete {@link SortModel} implementation for a data grid. This instance is used by the grid
+ * to manage grid's sort state.
+ * </p>
+ * @param sorts the {@link List} of sorts for a data grid
+ * @return the {@link SortModel} for a grid
+ */
public abstract SortModel createSortModel(List/*<Sort>*/ sorts);
+ /**
+ * <p>
+ * Create a concrete {@link org.apache.beehive.netui.databinding.datagrid.api.filter.Filter} implementation for a data grid. When the filter state of a data grid
+ * is created, this {@link org.apache.beehive.netui.databinding.datagrid.api.filter.Filter} instance will contain a single filter.
+ * </p>
+ * @return a {@link org.apache.beehive.netui.databinding.datagrid.api.filter.Filter} instance
+ */
public abstract Filter createFilter();
public abstract FilterModel createFilterModel(List/*<Filter>*/ filters);
@@ -70,7 +100,24 @@
public abstract DataGridResourceProvider getResourceProvider(String resourceBundle);
+ /**
+ * <p>
+ * Create a {@link StyleModel} used by a data grid to render styles onto various HTML markup elements
+ * generated by a data grid.
+ * </p>
+ * @param name the name of a style type to support. This name can vary by {@link DataGridConfig} implementation
+ * subclasses may use this value to configure the type of {@link StyleModel} returned to the caller.
+ * @param classPrefix an optional prefix to use when generating style class names
+ * @return the {@link StyleModel}
+ */
public abstract StyleModel getStyleModel(String name, String classPrefix);
+ /**
+ * <p>
+ * Create a concrete {@link PagerRenderer} implementation that will be used to render the pager
+ * in the absence of an alternate pager renderer.
+ * </p>
+ * @return the default {@link PagerRenderer} used to render a paging user interface
+ */
public abstract PagerRenderer getDefaultPagerRenderer();
}
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/filter/Filter.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/filter/Filter.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/filter/Filter.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/api/filter/Filter.java Tue May 10 19:22:46 2005
@@ -20,8 +20,23 @@
import org.apache.beehive.netui.util.logging.Logger;
/**
- *
- */
+* <p>
+* The Filter class is a JavaBean that abstractly represents the data needed to calculate a filter
+* for some data set. A filter consists of some {@link String} expression, a {@link FilterOperation}
+* and a filter value. The mechanism for applying a filter to a data set is not provided here.
+* </p>
+* <p>
+* A filter object can be used by some filtering infrastructure to either parameterize a SQL or XQuery
+* query or to simply sort an in-memory data set. For example,
+
+* query or to simply sort in-memory Java objects. For example, when converting a Sort into
+* a SQL fragment, a Sort with sortExpression "foo" and sortDirection {@link org.apache.beehive.netui.databinding.datagrid.api.sort.SortDirection.DESCENDING} could
+* be converted into:
+* <pre>
+* ORDER BY FOO DESC
+* </pre>
+* </p>
+*/
public class Filter
implements java.io.Serializable {
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/config/DefaultDataGridConfig.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/config/DefaultDataGridConfig.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/config/DefaultDataGridConfig.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/config/DefaultDataGridConfig.java Tue May 10 19:22:46 2005
@@ -24,8 +24,8 @@
import org.apache.beehive.netui.databinding.datagrid.api.sort.Sort;
import org.apache.beehive.netui.databinding.datagrid.api.sort.SortModel;
import org.apache.beehive.netui.databinding.datagrid.api.sort.SortStrategy;
-import org.apache.beehive.netui.databinding.datagrid.api.filter.Filter;
import org.apache.beehive.netui.databinding.datagrid.api.filter.FilterModel;
+import org.apache.beehive.netui.databinding.datagrid.api.filter.Filter;
import org.apache.beehive.netui.databinding.datagrid.api.pager.PagerModel;
import org.apache.beehive.netui.databinding.datagrid.api.rendering.PagerRenderer;
import org.apache.beehive.netui.databinding.datagrid.api.rendering.StyleModel;
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/config/DefaultDataGridStateCodec.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/config/DefaultDataGridStateCodec.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/config/DefaultDataGridStateCodec.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/config/DefaultDataGridStateCodec.java Tue May 10 19:22:46 2005
@@ -30,9 +30,9 @@
import org.apache.beehive.netui.databinding.datagrid.api.sort.SortDirection;
import org.apache.beehive.netui.databinding.datagrid.api.DataGridState;
import org.apache.beehive.netui.databinding.datagrid.api.pager.PagerModel;
-import org.apache.beehive.netui.databinding.datagrid.api.filter.Filter;
import org.apache.beehive.netui.databinding.datagrid.api.filter.FilterModel;
import org.apache.beehive.netui.databinding.datagrid.api.filter.FilterOperation;
+import org.apache.beehive.netui.databinding.datagrid.api.filter.Filter;
import org.apache.beehive.netui.databinding.datagrid.api.DataGridStateCodec;
import org.apache.beehive.netui.databinding.datagrid.api.DataGridConfig;
import org.apache.beehive.netui.databinding.datagrid.api.DataGridURLBuilder;
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/sql/SQLSupport.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/sql/SQLSupport.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/sql/SQLSupport.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/sql/SQLSupport.java Tue May 10 19:22:46 2005
@@ -27,8 +27,8 @@
import org.apache.beehive.netui.databinding.datagrid.api.filter.FilterOperation;
import org.apache.beehive.netui.databinding.datagrid.api.filter.FilterOperationHint;
-import org.apache.beehive.netui.databinding.datagrid.api.filter.Filter;
import org.apache.beehive.netui.databinding.datagrid.api.filter.FilterTypeHint;
+import org.apache.beehive.netui.databinding.datagrid.api.filter.Filter;
import org.apache.beehive.netui.databinding.datagrid.api.sort.SortDirection;
import org.apache.beehive.netui.databinding.datagrid.api.sort.Sort;
import org.apache.beehive.netui.databinding.datagrid.api.exceptions.IllegalFilterException;
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/util/JspFunctions.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/util/JspFunctions.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/util/JspFunctions.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/databinding/datagrid/runtime/util/JspFunctions.java Tue May 10 19:22:46 2005
@@ -22,9 +22,9 @@
import java.util.Map;
import javax.servlet.jsp.JspContext;
-import org.apache.beehive.netui.databinding.datagrid.api.filter.Filter;
import org.apache.beehive.netui.databinding.datagrid.api.DataGridConfigFactory;
import org.apache.beehive.netui.databinding.datagrid.api.DataGridURLBuilder;
+import org.apache.beehive.netui.databinding.datagrid.api.filter.Filter;
import org.apache.beehive.netui.databinding.datagrid.api.sort.SortModel;
import org.apache.beehive.netui.databinding.datagrid.api.sort.Sort;
import org.apache.beehive.netui.databinding.datagrid.api.sort.SortDirection;
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/bundle/DeclareBundle.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/bundle/DeclareBundle.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/bundle/DeclareBundle.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/bundle/DeclareBundle.java Tue May 10 19:22:46 2005
@@ -29,20 +29,20 @@
/**
* <p>A tag used to declare a {@link java.util.ResourceBundle} that can be used inside of the declaring
* page as a source for displaying internationalized messages. The declared resource bundle is accessible
- * using the <code>bundle</code> databinding context. The required <code>name</code> attribute specifies
+ * using the <code>bundle</code> implicit object. The required <code>name</code> attribute specifies
* the identifier via which to refer to the ResourceBundle in an expression. For example:</p>
* <pre>
* <netui-data:declareBundle name="someMessages" bundlePath="com/foobar/resources/WebAppMessages"/>
* </pre>
* <p>This tag declares a bundle that is referenced in a data binding expression as
- * <code>{bundle.someMessages}</code>.</p>
+ * <code>${bundle.someMessages}</code>.</p>
* <p>The bundle that is referenced depends on the Locale specified, see below. The resource bundle properties
* files that are accessed are located in the package <code>com/foobar/resources</code> with the root
* properties file name of <code>WebAppMessages</code>. The naming conventions for properties can be found
* in {@link java.util.ResourceBundle#getBundle(String, Locale, ClassLoader)}. These files must be located
* in a classpath that is available to the web application; often, this is WEB-INF/classes.
* If the properties file contains a key called <code>helloWorld</code>,
- * then the expression <code>{bundle.someMessages.helloWorld}</code>
+ * then the expression <code>${bundle.someMessages.helloWorld}</code>
* would be look-up the message matching the Locale specified on the tag. Bundle binding expressions can be
* used in any expression bindable NetUI tag attribute.</p>
* <p>Note, the name <code>default</code> is a bundle identifier that is reserved for use by the
@@ -65,14 +65,14 @@
* @jsptagref.tagdescription <p>Declares a {@link java.util.ResourceBundle java.util.ResourceBundle}
* as a source for displaying internationalized messages.
* The declared resource bundle is accessible
- * using the <code>{bundle...}</code> data binding context.
+ * using the <code>${bundle...}</code> data binding context.
* The required <code>name</code> attribute specifies
* the identifier used to refer to the ResourceBundle in an expression. For example:</p>
* <p/>
* <pre> <netui-data:declareBundle name="someMessages" bundlePath="com/foobar/resources/WebAppMessages"/></pre>
* <p/>
* <p>This tag declares a bundle that is referenced in a data binding expression as
- * <code>{bundle.someMessages}</code>.</p>
+ * <code>${bundle.someMessages}</code>.</p>
* <p/>
* <p>The bundle that is referenced depends on the <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Locale.html" target="_blank">java.util.Locale</a>
* specified. The resource bundle properties files that are accessed are located
@@ -82,7 +82,7 @@
* Locale, ClassLoader)</a> . These files must be located in a classpath that is
* available to the web application. Often, they are stored in <code>WEB-INF/classes</code>.
* If the properties file contains a key called <code>helloWorld</code>, then the
- * expression <code>{bundle.someMessages.helloWorld}</code> would look-up the message
+ * expression <code>${bundle.someMessages.helloWorld}</code> would look-up the message
* matching the Locale specified on the tag. Bundle binding expressions can be
* used in any data bindable <netui...> tag attribute.</p>
* <p>It is possible to have keys that contain multiple words separated by spaces,
@@ -91,17 +91,13 @@
* list illustrates three ways to access the key <code>My helloWorld</code> from the <code>someMessages</code>
* property file:</p>
* <ul>
- * <li><code><netui:label value="{bundle.someMessages['My helloWorld']}"/></code>
+ * <li><code><netui:span value="${bundle.someMessages['My helloWorld']}"/></code>
* </li>
- * <li><code><netui:label value='{bundle.someMessages["My helloWorld"]}'/></code>
+ * <li><code><netui:span value='${bundle.someMessages["My helloWorld"]}'/></code>
* </li>
- * <li><code><netui:label value="{bundle.someMessages[\"My helloWorld\"]}"/></code><br>
+ * <li><code><netui:span value="${bundle.someMessages[\"My helloWorld\"]}"/></code><br>
* </li>
* </ul>
- * <p>WebLogic Workshop automatically generates the last example listed above when
- * you set the label control in the property editor to <code>bundle.someMessages["My
- * helloWorld"]</code>. In all three cases, you WebLogic Workshop can successfully
- * retrieve the multi-word key.</p>
* <p><b>Note:</b> the name <code>default</code> is a bundle identifier that is reserved for use by the
* <netui-data:declareBundle> tag. If this value is used for the <code>name</code> attribute on a
* <netui-data:declareBundle> tag,
@@ -131,26 +127,26 @@
* language, and variant explicitly, but it does not write a message out to the
* JSP page.
* Writing out a message from this bundle is done inside of any of the
- * other tags using the {bundle...} data binding context.
+ * other tags using the <code>bundle</code> implicit object.
* <p/>
- * <pre> <netui:label value="<b>{bundle.messages.messageKey}</b>"/></pre>
+ * <pre> <netui:span value="<b>${bundle.messages.messageKey}</b>"/></pre>
* <p/>
* <p>The Struts <i18n:getMessage> tag is used to access a bundle
* <i>and</i> write the message out. It is roughly equivalent to doing the following:
* <p/>
- * <pre> <netui-data:declareBundle bundlePath="com/foobar/resources/messages"
- * name="messages"/>
- * <netui:label value="{bundle.messages.messageKey"/></pre>
- * <p/>
- * <p>An advantage of using the {bundle...} data binding context, is that it lets you
- * write into the <span>...</span> that the <netui:label>
- * creates, or into a <neuti:checkBox> name, etc.
- * just like using a regular String.
+ * <pre>
+ * <netui-data:declareBundle bundlePath="com/foobar/resources/messages" name="messages"/>
+ * <netui:span value="${bundle.messages.messageKey}"/></pre>
+ * <p/>
+ * <p>An advantage of using the ${bundle...} data binding context, is that it lets you
+ * write into the <span>...</span> that the <netui:span>
+ * creates, or into a <neuti:checkBox> name, etc. just like using a regular String.
+ *
* @netui:tag name="declareBundle" description="Use this tag to declare a resource bundle that is available in the bundle databinding context"
*/
public class DeclareBundle
- extends AbstractClassicTag
- implements TryCatchFinally {
+ extends AbstractClassicTag
+ implements TryCatchFinally {
private String _name = null;
private String _bundlePath = null;
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/cellrepeater/CellRepeater.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/cellrepeater/CellRepeater.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/cellrepeater/CellRepeater.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/cellrepeater/CellRepeater.java Tue May 10 19:22:46 2005
@@ -136,11 +136,11 @@
* not supported in the <netui-data:cellRepeater> tag.
* </p>
* @example In the following sample, the <netui-data:cellRepeater> tag creates a table with a
- * certain number of columns, as given in <code>{pageFlow.numColumns}</code> and as many
+ * certain number of columns, as given in <code>${pageFlow.numColumns}</code> and as many
* rows as necessary to display all the items in the data set.
* <pre>
- * <netui-data:cellRepeater dataSource="{pageFlow.itemArray}" columns="{pageFlow.numColumns}" >
- * Item: <netui:label value="{container.item}"/>
+ * <netui-data:cellRepeater dataSource="pageFlow.itemArray" columns="pageFlow.numColumns">
+ * Item: <netui:span value="${container.item}"/>
* </netui-data:cellRepeater>
* </pre>
* @netui:tag name="cellRepeater" description="A repeating, databound tag that renders its body into each cell of a table of the specified dimensions."
@@ -351,7 +351,7 @@
}
/**
- * Sets the tag's data source (can be an expression).
+ * Sets the tag's data source.
* @param dataSource - the data source
* @jsptagref.attributedescription <p>The <code>dataSource</code> attribute determines both
* (1) the source of populating data for the tag and
@@ -362,12 +362,7 @@
* (1) draw populating data from the Form Bean's foo property and (2)
* submit user defined data to the same property.
*
- * <p> <code><netui:textBox dataSource="{actionForm.foo}" /></code>
- *
- * <p>The <code>dataSource</code> attribute takes either a data binding expression or
- * the name of a Form Bean property. In the
- * above example, <code><netui:textBox dataSource="foo" /></code>
- * would have the exactly same behavior.
+ * <p> <code><netui:textBox dataSource="actionForm.foo" /></code>
*
* <p>When the tag is used to submit data, the data binding expression must
* refer to a Form Bean property.
@@ -378,7 +373,7 @@
* the Controller file ( = JPF file). The following <netui-data:repeater>
* tag draws its data from myIterativeData.
*
- * <p> <code><netui-data:cellRepeater dataSource="{pageFlow.myIterativeData}"></code>
+ * <p> <code><netui-data:cellRepeater dataSource="pageFlow.myIterativeData"></code>
* @jsptagref.databindable Read / Write
* @jsptagref.attributesyntaxvalue <i>expression_datasource</i>
* @netui:attribute required="true"
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/invoke/CallMethod.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/invoke/CallMethod.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/invoke/CallMethod.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/invoke/CallMethod.java Tue May 10 19:22:46 2005
@@ -53,19 +53,17 @@
* <p/>
* <p>For example, if you call a Java class with the following <netui-data:callMethod> tag...
* <p/>
- * <pre> <netui-data:callMethod
- * object="{pageFlow}"
- * method="hello"
- * <b>resultId="helloMessage"</b>
- * /></pre>
+ * <pre>
+ * <netui-data:callMethod object="${pageFlow}" method="hello" resultId="helloMessage"/>
+ * </pre>
* <p/>
- * <p>...the result of the call is stored in the <code>{pageContext...}</code> data binding context under the
+ * <p>...the result of the call is stored in the <code>pageScope</code> data binding context under the
* attribute <code>helloMessage</code>.
* <p/>
* <p>The result can be retrieved with the data binding expression
- * <code>{pageContext.helloMessage}</code>
+ * <code>${pageScope.helloMessage}</code>
* <p/>
- * <pre> <netui:label value="<b>{pageContext.helloMessage}</b>"/></pre>
+ * <pre> <netui:span value="<b>${pageScope.helloMessage}</b>"/></pre>
* <p/>
* In a scriptlet, the result can be retrieved by calling the <code>getAttribute()</code>
* method on the
@@ -73,10 +71,6 @@
* <p/>
* <pre> <%= pageContext.getAttribute("helloMessage") %></pre>
* <p/>
- * <p>Note that only synchronous methods can be called with <netui-data:callMethod>.
- * For handling asynchronous methods
- * see the help topic <a href="{@docRoot}/../guide/netui/guide/conCallingAWebServiceFromAPageFlow.html">
- * Calling Web Services and Custom Java Controls From A Page Flow</a>
* @netui:tag name="callMethod" description="Use this tag to call a method on an object."
* @see MethodParameter
* @see CallPageFlow
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/invoke/CallPageFlow.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/invoke/CallPageFlow.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/invoke/CallPageFlow.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/invoke/CallPageFlow.java Tue May 10 19:22:46 2005
@@ -66,7 +66,7 @@
* <p>The result can be retrieved with the data binding expression
* <code>{pageContext.helloMessage}</code>
* <p/>
- * <pre> <netui:label value="<b>{pageContext.helloMessage}</b>"/></pre>
+ * <pre> <netui:span value="<b>${pageContext.helloMessage}</b>"/></pre>
* <p/>
* In a scriptlet, the result can be retrieved by calling the <code>getAttribute()</code>
* method on the
@@ -74,19 +74,15 @@
* <p/>
* <pre> <%= pageContext.getAttribute("helloMessage") %></pre>
* <p/>
- * <p>Note that only synchronous methods can be called with <netui-data:callPageFlow>.
- * For handling asynchronous methods
- * see the help topic <a href="{@docRoot}/../guide/netui/guide/conCallingAWebServiceFromAPageFlow.html">
- * Calling Web Services and Custom Java Controls From A Page Flow</a>
* @example In the following sample, the <netui-data:callPageFlow> tag calls the
* sumCartItems method on the Controller file. The
* {@link org.apache.beehive.netui.tags.html.Label} tag
- * accesses the result through the {pageContext...} data binding context.
+ * accesses the result through the ${pageScope} data binding context.
* <pre> <netui-data:callPageFlow method="sumCartItems" resultId="cartSum">
- * <netui-data:methodParameter value="{pageFlow.cart.lineItemList}"/>
+ * <netui-data:methodParameter value="${pageFlow.cart.lineItemList}"/>
* </netui-data:callPageFlow>
* ...
- * <netui:label value="{pageContext.cartSum}"/></pre>
+ * <netui:span value="${pageContext.cartSum}"/></pre>
* @netui:tag name="callPageFlow" description="Use this tag to call a method on the current page flow controller."
* deprecated="true"
*/
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/message/Message.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/message/Message.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/message/Message.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/message/Message.java Tue May 10 19:22:46 2005
@@ -32,10 +32,11 @@
* <p/>
* <p>Curly-braces are used to identify argument place holders in the schema:
* <p/>
- * <pre> <%
+ * <pre>
+ * <%
* pageContext.setAttribute("msgSkeleton", new String("Hello {0}. {1} {2}, the current date and time are {3}."));
* %>
- * <netui-data:message value="{pageContext.msgSkeleton}" resultId="message"></pre>
+ * <netui-data:message value="${pageScope.msgSkeleton}" resultId="message"></pre>
* @example Defines a message schema, while the
* {@link org.apache.beehive.netui.tags.databinding.message.MessageArg} tags
* provide the parameters that plug values into the schema.
@@ -49,12 +50,12 @@
* pageContext.setAttribute("msgSkeleton", new String("To read about {0}, go to {1}."));
* %>
* ...
- * <netui-data:message value="{pageContext.msgSkeleton}" resultId="message">
+ * <netui-data:message value="${pageScope.msgSkeleton}" resultId="message">
* <netui-data:messageArg value="messaging"/>
* <netui-data:messageArg value="my web page"/>
* </netui-data:message>
* ...
- * <netui:label value="{pageContext.message}"/></pre>
+ * <netui:span value="${pageScope.message}"/></pre>
* <p/>
* <p>The following message is output to the JSP page:<p>
* <p/>
@@ -86,7 +87,7 @@
}
/**
- * @jsptagref.attributedescription A {pageContext...} or {request...} databinding expression.
+ * @jsptagref.attributedescription A <code>pageScope</code> or <code>requestScope</code> databinding expression.
* @jsptagref.databindable true
* @jsptagref.attributesyntaxvalue <i>expression_value</i>
* @netui:attribute required="true" rtexprvalue="true"
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/pageinput/DeclarePageInput.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/pageinput/DeclarePageInput.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/pageinput/DeclarePageInput.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/pageinput/DeclarePageInput.java Tue May 10 19:22:46 2005
@@ -31,7 +31,7 @@
* <p/>
* The DeclarePageInput tag is used to declare variables that are passed to the page from
* the page flow. A page input variable has a lifetime of the page in which it
- * is declared and can be referenced using the <code>pageInput</code> data binding context.
+ * is declared and can be referenced using the <code>pageInput</code> implicit object.
* The <code>name</code> attribute here is used as the identifier for the variable inside
* of this binding context, and the <code>type</code> attribute is used to identify
* the expected type of this variable.
@@ -61,13 +61,13 @@
* <p/>
* <p/>
* Once declared, the variable can be referenced using the
- * <code><b>{pageInput...}</b></code> data binding context.
+ * <code>pageInput</code> data binding context.
* The <code>name</code> attribute is used as the identifier for the variable inside
* of this binding context, and the <code>type</code> attribute is used to identify
* the expected type of this variable.
* </p>
* <p/>
- * <pre> <netui:label value="<b>{pageInput.myData}</b>"/></pre>
+ * <pre> <netui:span value="<b>${pageInput.myData}</b>"/></pre>
* <p/>
* <p>Using the <netui-data:declarePageInput> has the following advantages
* <p/>
@@ -113,10 +113,11 @@
* <h4>Code in a JSP page...</h4>
* <pre> <netui-data:declarePageInput name="fooBean" type="pageInput.PageInputController.FooBean"/>
* ...
- * fooBean.foo: <netui:label value="{pageInput.fooBean.foo}" /></pre>
- * @netui:tag name="declarePageInput"
+ * fooBean.foo: <netui:span value="${pageInput.fooBean.foo}" />
+ * </pre>
+ *
+ * @netui:tag name="declarePageInput" body-content="scriptless"
* description="Use this tag to declare a page input variable that is available in the pageInput databinding context."
- * body-content="scriptless"
*/
public class DeclarePageInput
extends AbstractSimpleTag {
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/Repeater.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/Repeater.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/Repeater.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/Repeater.java Tue May 10 19:22:46 2005
@@ -54,8 +54,8 @@
* of the current "customer" in the data set.</p>
* <pre>
* <ul>
- * <netui-data:repeater dataSource="{pageInput.customers}">
- * <li><netui:label value="{container.item.lastName}, {container.item.firstName}"/></li>
+ * <netui-data:repeater dataSource="pageInput.customers">
+ * <li><netui:span value="${container.item.lastName}, ${container.item.firstName}"/></li>
* </netui-data:repeater>
* </ul>
* </pre>
@@ -66,14 +66,14 @@
* inside the structured tags of the repeater is rendered.</p>
* <p>For example, the following will render the same output as the example
* shown above, but it uses the structured tags for rendering the
- * <code>{pageFlow.customers}</code> expression:</p>
+ * <code>pageFlow.customers</code> expression:</p>
* <pre>
- * <netui-data:repeater dataSource="{pageInput.customers}">
+ * <netui-data:repeater dataSource="pageInput.customers">
* <netui-data:repeaterHeader>
* <ul>
* </netui-data:repeaterHeader>
* <netui-data:repeaterItem>
- * <li><netui:label value="{container.item.lastName}, {container.item.firstName}"/></li>
+ * <li><netui:span value="${container.item.lastName}, ${container.item.firstName}"/></li>
* </netui-data:repeaterItem>
* <netui-data:repeaterFooter>
* </ul>
@@ -104,8 +104,8 @@
* render the items in the "customers" data set as an unordered HTML list.</p>
* <p/>
* <pre> <ul>
- * <netui-data:repeater dataSource="{pageInput.customers}">
- * <li><netui:label value="{container.item.lastName}, {container.item.firstName}"/></li>
+ * <netui-data:repeater dataSource="pageInput.customers">
+ * <li><netui:span value="${container.item.lastName}, ${container.item.firstName}"/></li>
* </netui-data:repeater>
* </ul></pre>
* <p/>
@@ -120,12 +120,12 @@
* HTML markup:</p>
* <p/>
* <pre>
- * <netui-data:repeater dataSource="{pageInput.customers}">
+ * <netui-data:repeater dataSource="pageInput.customers">
* <netui-data:repeaterHeader>
* <ul>
* </netui-data:repeaterHeader>
* <netui-data:repeaterItem>
- * <li><netui:label value="{container.item.lastName}, {container.item.firstName}"/></li>
+ * <li><netui:span value="${container.item.lastName}, ${container.item.firstName}"/></li>
* </netui-data:repeaterItem>
* <netui-data:repeaterFooter>
* </ul>
@@ -134,7 +134,7 @@
* @example The following sample renders the data set as an HTML table. The table has two columns, "index" and "name",
* and each iteration over the data set is rendered as a row of the table.
* <p/>
- * <pre> <netui-data:repeater dataSource="{pageInput.myDataSet}">
+ * <pre> <netui-data:repeater dataSource="pageInput.myDataSet">
* <netui-data:repeaterHeader>
* <table border="1">
* <tr>
@@ -145,10 +145,10 @@
* <netui-data:repeaterItem>
* <tr>
* <td>
- * <netui:label value="{container.index}" />
+ * <netui:span value="${container.index}" />
* </td>
* <td>
- * <netui:label value="{container.item}" />
+ * <netui: value="${container.item}" />
* </td>
* </tr>
* </netui-data:repeaterItem>
@@ -697,7 +697,7 @@
* (1) draw populating data from the Form Bean's foo property and (2)
* submit user defined data to the same property.
*
- * <p> <code><netui:textBox dataSource="{actionForm.foo}" /></code>
+ * <p> <code><netui:textBox dataSource="actionForm.foo" /></code>
*
* <p>The <code>dataSource</code> attribute takes either a data binding expression or
* the name of a Form Bean property. In the
@@ -713,7 +713,7 @@
* the Controller file ( = JPF file). The following <netui-data:repeater>
* tag draws its data from myIterativeData.
*
- * <p> <code><netui-data:repeater dataSource="{pageFlow.myIterativeData}"></code>
+ * <p> <code><netui-data:repeater dataSource="pageFlow.myIterativeData"></code>
* @jsptagref.databindable Read / Write
* @jsptagref.attributesyntaxvalue <i>expression_datasource</i>
* @netui:attribute required="true"
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/RepeaterFooter.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/RepeaterFooter.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/RepeaterFooter.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/RepeaterFooter.java Tue May 10 19:22:46 2005
@@ -44,7 +44,7 @@
* and each iteration over the data set is rendered a row of the table. The <netui-data:repeaterFooter>
* tag renders once, after the iteration is complete. It renders a closing HTML table tag.
* <p/>
- * <pre> <netui-data:repeater dataSource="{pageFlow.myDataSet}">
+ * <pre> <netui-data:repeater dataSource="pageFlow.myDataSet">
* <netui-data:repeaterHeader>
* <table border="1">
* <tr>
@@ -55,10 +55,10 @@
* <netui-data:repeaterItem>
* <tr>
* <td>
- * <netui:label value="{container.index}" />
+ * <netui:span value="${container.index}" />
* </td>
* <td>
- * <netui:label value="{container.item}" />
+ * <netui:span value="${container.item}" />
* </td>
* </tr>
* </netui-data:repeaterItem>
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/RepeaterHeader.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/RepeaterHeader.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/RepeaterHeader.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/RepeaterHeader.java Tue May 10 19:22:46 2005
@@ -44,7 +44,7 @@
* tag renders once, before the iteration has begun. It renders an opening HTML table tag and
* two header rows for the table.
* <p/>
- * <pre> <netui-data:repeater dataSource="{pageFlow.myDataSet}">
+ * <pre> <netui-data:repeater dataSource="pageFlow.myDataSet">
* <b><netui-data:repeaterHeader></b>
* <table border="1">
* <tr>
@@ -55,10 +55,10 @@
* <netui-data:repeaterItem>
* <tr>
* <td>
- * <netui:label value="{container.index}" />
+ * <netui:span value="${container.index}" />
* </td>
* <td>
- * <netui:label value="{container.item}" />
+ * <netui:span value="${container.item}" />
* </td>
* </tr>
* </netui-data:repeaterItem>
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/RepeaterItem.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/RepeaterItem.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/RepeaterItem.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/repeater/RepeaterItem.java Tue May 10 19:22:46 2005
@@ -30,7 +30,7 @@
* @jsptagref.tagdescription This tag is used to render an individual item in the data set as it is iterated over by
* the {@link Repeater} tag.
* As an individual item is being iterated over, it is available using the
- * <code>{container.item}</code> databinding expression.
+ * <code>${container.item}</code> databinding expression.
* <p>The <netui-data:repeaterItem> tag can only be uesd when directly contained by
* a <netui-data:repeater> tag.</p>
* <p>By default, the <netui-data:repeaterItem> simply renders its body once for each of the items in the
@@ -38,7 +38,7 @@
* @example The following sample renders the data set as an HTML table. The <netui-data:repeaterItem> tag
* renders a new row in the table for each item in the data set.
* <p/>
- * <pre> <netui-data:repeater dataSource="{pageFlow.myDataSet}">
+ * <pre> <netui-data:repeater dataSource="pageFlow.myDataSet">
* <netui-data:repeaterHeader>
* <table border="1">
* <tr>
@@ -49,10 +49,10 @@
* <b><netui-data:repeaterItem></b>
* <tr>
* <td>
- * <netui:label value="{container.index}" />
+ * <netui:span value="${container.index}" />
* </td>
* <td>
- * <netui:label value="{container.item}" />
+ * <netui:span value="${container.item}" />
* </td>
* </tr>
* <b></netui-data:repeaterItem></b>
Modified: incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/script/GetData.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/script/GetData.java?rev=169561&r1=169560&r2=169561&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/script/GetData.java (original)
+++ incubator/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/script/GetData.java Tue May 10 19:22:46 2005
@@ -40,7 +40,7 @@
* places it
* in the <code>myData</code> field of the PageContext object:
* <p/>
- * <pre> <netui-data:getData resultId="myData" value="{pageFlow.myData}"/></pre>
+ * <pre> <netui-data:getData resultId="myData" value="${pageFlow.myData}"/></pre>
* <p/>
* <p>The following scriptlet extracts the data from the <code>PageContext</code>
* object and writes it to the rendered HTML:
@@ -51,7 +51,7 @@
* through the PageContext's <code>getAttribute(String)</code> method.
* <pre> <netui:form action="lastNameAction" focus="lastname">
* ...
- * <netui-data:getData resultId="first" value="{actionForm.firstname}"/>
+ * <netui-data:getData resultId="first" value="${actionForm.firstname}"/>
* ...
* <%
* String firstName = (String) pageContext.getAttribute("first");
@@ -64,11 +64,11 @@
* <p>This next sample shows how to use <netui-data:getData> and the <code>PageContext</code>
* inside of other containers, in this case a <netui-data:repeater> tag. The <netui-data:getData> below
* extracts each element as the <netui-data:repeater> iterates over the data set and writes it to the Java console:</p>
- * <pre> <netui-data:repeater dataSource="{pageFlow.strArr}">
+ * <pre> <netui-data:repeater dataSource="pageFlow.strArr">
* ...
* <netui-data:repeaterItem>
- * <netui:label value="{container.item}" />
- * <netui-data:getData resultId="item" value="{container.item}"/>
+ * <netui:span value="${container.item}" />
+ * <netui-data:getData resultId="item" value="${container.item}"/>
* <%
* String currentItem = (String) pageContext.getAttribute("item");
* System.out.println(currentItem);