tapestry-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bobhar...@apache.org
Subject tapestry-5 git commit: Fixed TAP5-2561 (BeanDisplay documentation needs to be updated in regard to CSS class of outer <dl> element). Also tweaked related BeanEditor and BeanEditForm javadocs. No functional changes here.
Date Mon, 05 Sep 2016 21:52:13 GMT
Repository: tapestry-5
Updated Branches:
  refs/heads/master d372f1e0d -> e85e02a3d


Fixed TAP5-2561 (BeanDisplay documentation needs to be updated in regard
to CSS class of outer <dl> element).
Also tweaked related BeanEditor and BeanEditForm javadocs. No functional
changes here.

Project: http://git-wip-us.apache.org/repos/asf/tapestry-5/repo
Commit: http://git-wip-us.apache.org/repos/asf/tapestry-5/commit/e85e02a3
Tree: http://git-wip-us.apache.org/repos/asf/tapestry-5/tree/e85e02a3
Diff: http://git-wip-us.apache.org/repos/asf/tapestry-5/diff/e85e02a3

Branch: refs/heads/master
Commit: e85e02a3d364ff0a0c361e4763672a98cb62a92a
Parents: d372f1e
Author: Bob Harner <bobharner@gmail.com>
Authored: Mon Sep 5 17:50:34 2016 -0400
Committer: Bob Harner <bobharner@gmail.com>
Committed: Mon Sep 5 17:50:34 2016 -0400

----------------------------------------------------------------------
 .../tapestry5/corelib/components/BeanDisplay.java | 18 ++++++++++--------
 .../corelib/components/BeanEditForm.java          | 13 ++++++-------
 .../tapestry5/corelib/components/BeanEditor.java  |  8 +++++---
 3 files changed, 21 insertions(+), 18 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/e85e02a3/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanDisplay.java
----------------------------------------------------------------------
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanDisplay.java
b/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanDisplay.java
index 630092c..1250e53 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanDisplay.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanDisplay.java
@@ -24,15 +24,17 @@ import org.apache.tapestry5.ioc.annotations.Inject;
 import org.apache.tapestry5.services.BeanModelSource;
 
 /**
- * Used to display the properties of a bean, using an underlying {@link BeanModel}. The output
definition list: a
- * &lt;dl&gt; element containing a series of &lt;dt&gt;/&lt;dd&gt;
pairs. The property label is used as the &lt;dt&gt;
- * and the property value (formatted as per the datatype) is the &lt;dd&gt;. Only
properties that have a known data type
+ * A component that displays the properties of a bean (or POJO, or any object with properties)
as a
+ * simple HTML <em>definition</em> list. Uses a {@link BeanModel} (either explicitly
provided, or generated by Tapestry).
+ * <p>
+ * The output is a &lt;dl&gt; element containing a series of &lt;dt&gt; -
&lt;dd&gt; pairs, where the &lt;dt&gt; contains
+ * the property's label and the &lt;dd&gt; contains the  property's value (formatted
as per its datatype). Only properties that have a known data type
  * are displayed.
- *
- * The property id is used as the class attribute of the &lt;dt&gt; and &lt;dd&gt;
element, allowing CSS customization
- * per property. This does not occur when lean is bound to true.
- *
- * The outer &lt;dl&gt; element has the CSS class "t-beandisplay".
+ * <p>
+ * The property id is used as the class attribute of the &lt;dt&gt; and &lt;dd&gt;
element (allowing CSS customization
+ * per property), unless the lean parameter is true.
+ * <p>
+ * The outer &lt;dl&gt; element has the CSS class "well dl-horizontal" (Tapestry
5.4 and later) or "t-beandisplay" (Tapestry 5.3.x and earlier).
  * 
  * @see org.apache.tapestry5.beaneditor.DataType
  * @see BeanModel

http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/e85e02a3/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditForm.java
----------------------------------------------------------------------
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditForm.java
b/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditForm.java
index 07f7c35..6f72a93 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditForm.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditForm.java
@@ -20,18 +20,17 @@ import org.apache.tapestry5.ioc.annotations.Inject;
 import org.apache.tapestry5.services.BeanModelSource;
 
 /**
- * A component that creates an entire form editing the properties of a particular bean. Inspired
by <a
- * href="http://www.trailsframework.org/">Trails</a> and <a href="http://beanform.sourceforge.net/">BeanForm</a>
(both
- * for Tapestry 4). Generates a simple UI for editing the properties of a JavaBean, with
the flavor of UI for each
+ * A component that creates an entire form for editing the properties of a particular bean
(or POJO, or any object
+ * with properties). Generates a simple UI for editing the properties of the object, with
the UI for each
  * property (text field, checkbox, drop down list) determined from the property type (or
by other means, such as an
  * annotation), and the order and validation for the properties determined from annotations
on the property's getter and
  * setter methods.
- *
- * You may add block parameters to the component; when the name matches (case insensitive)
the name of a property, then
- * the corresponding Block is renderered, rather than any of the built in property editor
blocks. This allows you to
+ * <p>
+ * You may add block parameters to the component; when the name matches the name of a property
(case insensitively), then
+ * the corresponding Block is rendered, rather than any of the built in property editor blocks.
This allows you to
  * override specific properties with your own customized UI, for cases where the default
UI is insufficient, or no
  * built-in editor type is appropriate.
- *
+ * <p>
  * BeanEditForm contains a {@link org.apache.tapestry5.corelib.components.Form} component
and will trigger all the
  * events of a Form.
  *

http://git-wip-us.apache.org/repos/asf/tapestry-5/blob/e85e02a3/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditor.java
----------------------------------------------------------------------
diff --git a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditor.java
b/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditor.java
index 45a9711..2e29d10 100644
--- a/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditor.java
+++ b/tapestry-core/src/main/java/org/apache/tapestry5/corelib/components/BeanEditor.java
@@ -34,9 +34,11 @@ import org.apache.tapestry5.services.Environment;
 import org.apache.tapestry5.services.FormSupport;
 
 /**
- * A component that generates a user interface for editing the properties of a bean. This
is the central component of
- * the {@link BeanEditForm}, and utilizes a {@link PropertyEditor} for much of its functionality.
This component places
- * a {@link BeanEditContext} into the environment.
+ * A component that generates a user interface for editing the properties of a bean (or POJO,
+ * or any object with properties). This is the central component of the {@link BeanEditForm}
+ * component, and it utilizes the {@link PropertyEditor} component for much of its functionality.
+ * <p>
+ * This component places a {@link BeanEditContext} into the {@link Environment}.
  * 
  * @tapestrydoc
  */


Mime
View raw message