svn commit: r422761 - in /beehive/trunk/netui/src: tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/AnchorCell.java tags-html/org/apache/beehive/netui/tags/html/Anchor.java tags-html/org/apache/beehive/netui/tags/html/AnchorBase.java

[cr...@apache.org]

Author: crogers
Date: Mon Jul 17 09:54:23 2006
New Revision: 422761

URL: http://svn.apache.org/viewvc?rev=422761&view=rev
Log:
Fix for http://issues.apache.org/jira/browse/BEEHIVE-1132 - tag docs for anchor and anchorCell tags should be more specific about href URL and use of parameter tag.

This is a contribution from Jeremiah Johnson. Thanks for the help Jeremiah!

tests: NetUI BVT (WinXP pass), build.dist


Modified:
    beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/AnchorCell.java
    beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Anchor.java
    beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/AnchorBase.java

Modified: beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/AnchorCell.java
URL: http://svn.apache.org/viewvc/beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/AnchorCell.java?rev=422761&r1=422760&r2=422761&view=diff
==============================================================================
--- beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/AnchorCell.java (original)
+++ beehive/trunk/netui/src/tags-databinding/org/apache/beehive/netui/tags/databinding/datagrid/AnchorCell.java Mon Jul 17 09:54:23 2006
@@ -370,7 +370,9 @@
      * Sets the href of the HTML anchor. This attribute will accept the empty String as a legal value.
      *
      * @param href the hyperlink URI for the HTML anchor.
-     * @jsptagref.attributedescription The URL to go to.
+     * @jsptagref.attributedescription The URL to go to; if the URL needs
+     * parameters, use the parameter tag to get proper encoding of special
+     * characters in the parameters.
      * @jsptagref.attributesyntaxvalue <i>string_href</i>
      * @netui:attribute required="false" rtexprvalue="true"
      * description="The href of the HTML anchor."

Modified: beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Anchor.java
URL: http://svn.apache.org/viewvc/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Anchor.java?rev=422761&r1=422760&r2=422761&view=diff
==============================================================================
--- beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Anchor.java (original)
+++ beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Anchor.java Mon Jul 17 09:54:23 2006
@@ -55,6 +55,21 @@
  * </ul>
  * </blockquote>
  * </p>
+ * <p>
+ * The Anchor tag can accept NetUI parameter tags that implement the
+ * {@link IUrlParams} interface.  When parameter tags are contained inside of
+ * the Anchor tag, they add URL parameters onto the rendered href.  For
+ * example:
+ * <pre>
+ *   &lt;netui:anchor href="foo.jsp" value="Go To Foo">
+ *     &lt;netui:parameter name="paramKey" value="paramValue"/>
+ *   &lt;/netui:anchor>
+ * </pre>
+ * will render:
+ * <pre>
+ *   &lt;a href="foo.jsp?paramKey=paramValue">Go To Foo&lt;/a>
+ * </pre>
+ * </p>
  * @example <b>Submitting Form Data</b>
  * <p>In this sample, clicking on this anchor submits the form data and invokes the method
  * <code>submitForm</code>.

Modified: beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/AnchorBase.java
URL: http://svn.apache.org/viewvc/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/AnchorBase.java?rev=422761&r1=422760&r2=422761&view=diff
==============================================================================
--- beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/AnchorBase.java (original)
+++ beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/AnchorBase.java Mon Jul 17 09:54:23 2006
@@ -113,7 +113,9 @@
     /**
      * Sets the href of the Anchor. This attribute will accept the empty String as a legal value.
      * @param href the hyperlink URI for the Area.
-     * @jsptagref.attributedescription The URL to go to.
+     * @jsptagref.attributedescription The URL to go to; if the URL needs
+     * parameters, use the parameter tag to get proper encoding of special
+     * characters in the parameters.
      * @jsptagref.databindable false
      * @jsptagref.attributesyntaxvalue <i>string_href</i>
      * @netui:attribute required="false" rtexprvalue="true"