You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by ri...@apache.org on 2005/05/16 18:42:14 UTC
svn commit: r170407 [1/2] - in /incubator/beehive/trunk/netui:
src/tags-html/org/apache/beehive/netui/tags/html/
src/tags-html/org/apache/beehive/netui/tags/javascript/
src/tags-html/org/apache/beehive/netui/tags/tree/
test/webapps/drt/coreWeb/tags/accesskeyGroup/
Author: rich
Date: Mon May 16 09:42:11 2005
New Revision: 170407
URL: http://svn.apache.org/viewcvs?rev=170407&view=rev
Log:
This is a contribution from Carlin Rogers to address http://issues.apache.org/jira/browse/BEEHIVE-710 : netui tag libraries documentation: imageAnchor through textBox tags
(contains only javadoc changes)
tests: drt in trunk (WinXP)
BB: self (linux)
Modified:
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Anchor.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Area.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Attribute.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/BindingUpdateErrors.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/CheckBoxGroup.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/CheckBoxOption.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Error.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ErrorBaseTag.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Form.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatTag.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlBaseTag.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlFocusBaseTag.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlGroupBaseTag.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ImageAnchor.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ImageButton.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Label.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/LabelBase.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Parameter.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RadioButtonGroup.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RewriteName.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RewriteURL.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Select.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/SelectOption.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/javascript/ScriptHeader.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/Tree.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeContent.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeHtmlAttribute.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeLabel.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreePropertyOverride.java
incubator/beehive/trunk/netui/test/webapps/drt/coreWeb/tags/accesskeyGroup/Controller.jpf
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Anchor.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Anchor.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Anchor.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Anchor.java Mon May 16 09:42:11 2005
@@ -49,7 +49,7 @@
* <li><code>action</code> - the action method invoked by clicking the hyperlink</li>
* <li><code>href</code> - the URL to go to</li>
* <li><code>linkName</code> - an internal place in the page to move to</li>
- * <li><code>clientAction - the action to run on the client</li>
+ * <li><code>clientAction</code> - the action to run on the client</li>
* <li><code>tagId</code> - the ID of the tag</li>
* <li><code>formSubmit</code> - indicates whether or not the enclosing Form should be submitted</li>
* </ul>
@@ -158,7 +158,7 @@
* @param action an action to run on the client.
* @jsptagref.attributedescription The action (NetUI JavaScript) to run on the client.
* @jsptagref.databindable false
- * @jsptagref.attributesyntaxvalue <i>string_client_action</i>
+ * @jsptagref.attributesyntaxvalue <i>string_clientAction</i>
* @netui:attribute required="false" rtexprvalue="true" description="The client action."
* description="The action (NetUI JavaScript) to run on the client."
*/
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Area.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Area.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Area.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Area.java Mon May 16 09:42:11 2005
@@ -11,20 +11,20 @@
/**
* @jsptagref.tagdescription
* Generates a URL-encoded area to a specified URI.
- * @netui:tag name="area" description="Generates a URL-encoded area to a specified URI."
* @example In this sample, an area tag is written with the shape, coords, href, and alt attributes,
* for an image map associated with the "someDefaultPic.jpg" image.
* <p>The following <netui> tags...</p>
- * <pre><netui:image src="someDefaultPic.jpg" alt="a default picture" usemap="#defaultMap"/>
- * <map id="defaultMap" name="defaultMap">
- * <netui:area shape="rect" coords="0,0,80,80" href="bigPicture.jsp" alt="big picture of the image"/>
- * </map></pre>
+ * <pre> <netui:image src="someDefaultPic.jpg" alt="a default picture" usemap="#defaultMap"/>
+ * <map id="defaultMap" name="defaultMap">
+ * <netui:area shape="rect" coords="0,0,80,80" href="bigPicture.jsp" alt="big picture of the image"/>
+ * </map></pre>
*
* <p>...output the following HTML:</p>
- * <pre><img src="someDefaultPic.jpg" usemap="#defaultMap" alt="a default picture">
- * <map id="defaultMap" name="defaultMap">
- * <area href="bigPicture.jsp" shape="rect" alt="big picture of the image" coords="0,0,80,80">
- * </map></pre>
+ * <pre> <img src="someDefaultPic.jpg" usemap="#defaultMap" alt="a default picture">
+ * <map id="defaultMap" name="defaultMap">
+ * <area href="bigPicture.jsp" shape="rect" alt="big picture of the image" coords="0,0,80,80">
+ * </map></pre>
+ * @netui:tag name="area" description="Generates a URL-encoded area to a specified URI."
* @see Attribute
* @see java.lang.String
*/
@@ -54,7 +54,7 @@
* Sets the property to specify the alt text of the image.
* @param alt - the image alignment.
* @jsptagref.attributedescription Specifies alternate text for the area.
- * @jsptagref.databindable true
+ * @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_alt</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Specifies alternate text for the area."
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Attribute.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Attribute.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Attribute.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Attribute.java Mon May 16 09:42:11 2005
@@ -93,7 +93,7 @@
* Sets the <code>facet</code> attribute.
* @param facet - the value of the <code>facet</code> attribute.
* @jsptagref.attributedescription The name of the facet targetted by the attribute.
- * @jsptagref.databindable true
+ * @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_or_expression_value</i>
* @netui:attribute rtexprvalue="true"
* description="The name of the facet targetted by the attribute."
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/BindingUpdateErrors.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/BindingUpdateErrors.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/BindingUpdateErrors.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/BindingUpdateErrors.java Mon May 16 09:42:11 2005
@@ -91,7 +91,7 @@
* @jsptagref.attributedescription Boolean. If <code>isAlwaysReport</code> is set to true, then the errors will be displayed in Production mode
* as well as in Development mode. Otherwise, the errors will be displayed only in Development mode.
* @jsptagref.databindable false
- * @jsptagref.attributesyntaxvalue <i>boolean_always_report</i>
+ * @jsptagref.attributesyntaxvalue <i>boolean_alwaysReport</i>
* @netui:attribute required="false" rtexprvalue="true" type="boolean"
* description="If isAlwaysReport is set to true, then the errors will be displayed in Production mode
* as well as in Development mode. Otherwise, the errors will be displayed only in Development mode."
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/CheckBoxGroup.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/CheckBoxGroup.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/CheckBoxGroup.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/CheckBoxGroup.java Mon May 16 09:42:11 2005
@@ -42,32 +42,33 @@
*
* If CheckBoxGroup uses any Format tags, it must have those tags come before any nested
* CheckBoxOption tags.
- * @jsptagref.tagdescription Handles data binding for a collection of checkboxes.
+ * @jsptagref.tagdescription Renders a collection of checkbox options as <input type="checkbox">
+ * and handles the data binding.
*
* <p><b>Submitting Data</b></p>
* <p>The <netui:checkBoxGroup> submits data in the form of a String[] object.
* For example, if the <netui:checkBoxGroup> submits data to a Form Bean field...
*
- * <pre> <netui:checkBoxGroup
- * dataSource="actionForm.userSelections"
- * optionsDataSource="${pageFlow.availableSelections}" /></pre>
+ * <pre> <netui:checkBoxGroup
+ * dataSource="actionForm.userSelections"
+ * optionsDataSource="${pageFlow.availableSelections}" /></pre>
*
* ...then the Form Bean field must be a String[] object...
*
- * <pre> public static class SubmitForm extends FormData
- * {
- * private String[] userSelections;
- *
- * public void setUserSelections(String[] userSelections)
- * {
- * this.userSelections = userSelections;
- * }
- *
- * public String[] getUserSelections()
- * {
- * return this.userSelections;
- * }
- * }</pre>
+ * <pre> public static class SubmitForm extends FormData
+ * {
+ * private String[] userSelections;
+ *
+ * public void setUserSelections(String[] userSelections)
+ * {
+ * this.userSelections = userSelections;
+ * }
+ *
+ * public String[] getUserSelections()
+ * {
+ * return this.userSelections;
+ * }
+ * }</pre>
*
* <p><b>Dynamically Defined Checkboxes</b></p>
* You can dynamically define a set of checkboxes by pointing the <code>optionsDataSource</code> attribute
@@ -77,24 +78,24 @@
*
* <p>For example, if you define a String[] object and get method in the Controller file...
*
- * <pre> public String[] availableOptions = {"option1", "option2", "option3"};
+ * <pre> public String[] availableOptions = {"option1", "option2", "option3"};
*
- * public String[] getAvailableOptions()
- * {
- * return this.availableOptions;
- * }</pre>
+ * public String[] getAvailableOptions()
+ * {
+ * return this.availableOptions;
+ * }</pre>
*
* ...and reference this String[] from the <code>optionsDataSource</code> attribute...
*
- * <pre> <netui:checkBoxGroup
- * dataSource="actionForm.userSelections"
- * optionsDataSource="${pageFlow.availableSelections}" /></pre>
+ * <pre> <netui:checkBoxGroup
+ * dataSource="actionForm.userSelections"
+ * optionsDataSource="${pageFlow.availableSelections}" /></pre>
*
* ...then the appropriate checkboxes will be rendered in the browser.
*
- * <pre> <input type="checkbox" value="option1">option1</input>
- * <input type="checkbox" value="option2">option2</input>
- * <input type="checkbox" value="option3">option3</input></pre>
+ * <pre> <input type="checkbox" name="wlw-checkbox_group_key:{actionForm.userSelections}" value="option1">option1</input>
+ * <input type="checkbox" name="wlw-checkbox_group_key:{actionForm.userSelections}" value="option2">option2</input>
+ * <input type="checkbox" name="wlw-checkbox_group_key:{actionForm.userSelections}" value="option3">option3</input></pre>
*
* For checkboxes to be rendered, either the <code>optionsDataSource</code> attribute must be provided
* (and point to a String[] object) or the <netui:checkBoxGroup> must have children
@@ -108,42 +109,51 @@
* @example In this first sample, the <netui:checkBoxGroup>
* submits data to the Form Bean field <code>preferredColors</code>.
*
- * <pre> <netui:checkBoxGroup
- * dataSource="actionForm.preferredColors"
- * optionsDataSource="${pageFlow.colors}" /></pre>
+ * <pre> <netui:checkBoxGroup
+ * dataSource="actionForm.preferredColors"
+ * optionsDataSource="${pageFlow.colors}" /></pre>
*
* The <code>optionsDataSource</code> attribute points to a get method for a String[] on the Controller file:
*
- * <pre> colors = new String[] {"Red", "Blue", "Green", "Yellow", "White", "Black"};
+ * <pre> String[] colors = new String[] {"Red", "Blue", "Green", "Yellow", "White", "Black"};
*
- * public String[] getColors()
- * {
- * return colors;
- * }</pre>
+ * public String[] getColors()
+ * {
+ * return colors;
+ * }</pre>
*
* This automatically renders the appropriate set of checkbox options within the <checkBoxGroup>:
*
- * <pre> <input type="checkbox" value="Red">Red</input>
- * <input type="checkbox" value="Blue">Blue</input>
- * <input type="checkbox" value="Green">Green</input>
- * <input type="checkbox" value="Yellow">Yellow</input>
- * <input type="checkbox" value="White">White</input>
- * <input type="checkbox" value="Black">Black</input></pre>
+ * <pre> <input type="checkbox" name="wlw-checkbox_group_key:{actionForm.preferredColors}" value="Red">Red</input>
+ * <input type="checkbox" name="wlw-checkbox_group_key:{actionForm.preferredColors}" value="Blue">Blue</input>
+ * <input type="checkbox" name="wlw-checkbox_group_key:{actionForm.preferredColors}" value="Green">Green</input>
+ * <input type="checkbox" name="wlw-checkbox_group_key:{actionForm.preferredColors}" value="Yellow">Yellow</input>
+ * <input type="checkbox" name="wlw-checkbox_group_key:{actionForm.preferredColors}" value="White">White</input>
+ * <input type="checkbox" name="wlw-checkbox_group_key:{actionForm.preferredColors}" value="Black">Black</input></pre>
*
* The <code>defaultValue</code> attribute may point to a String or a String[].
*
- * <pre> defaultValue = new String ("Blue");</pre>
- * <pre> defaultValue = new String[] {"Red", "Blue"};</pre>
+ * <pre> <netui:checkBoxGroup
+ * dataSource="actionForm.preferredColors"
+ * optionsDataSource="${pageFlow.colors}"
+ * defaultValue="${pageFlow.defaultColor}" /></pre>
+ *
+ * And in the Controller:
+ * <pre> String defaultColor = new String ("Blue");
+ * ...</pre>
+ * or
+ * <pre> String[] defaultColor = new String[] {"Red", "Blue"};
+ * ...</pre>
*
* In either case, the appropriate
* checkbox options will appear checked in the browser.
*
- * <pre> <input type="checkbox" value="Red" checked="true">Red</input>
- * <input type="checkbox" value="Blue" checked="true">Blue</input>
- * <input type="checkbox" value="Green">Green</input>
- * <input type="checkbox" value="Yellow">Yellow</input>
- * <input type="checkbox" value="White">White</input>
- * <input type="checkbox" value="Black">Black</input></pre>
+ * <pre> <input type="checkbox" name="wlw-checkbox_group_key:{actionForm.preferredColors}" value="Red" checked="true">Red</input>
+ * <input type="checkbox" name="wlw-checkbox_group_key:{actionForm.preferredColors}" value="Blue" checked="true">Blue</input>
+ * <input type="checkbox" name="wlw-checkbox_group_key:{actionForm.preferredColors}" value="Green">Green</input>
+ * <input type="checkbox" name="wlw-checkbox_group_key:{actionForm.preferredColors}" value="Yellow">Yellow</input>
+ * <input type="checkbox" name="wlw-checkbox_group_key:{actionForm.preferredColors}" value="White">White</input>
+ * <input type="checkbox" name="wlw-checkbox_group_key:{actionForm.preferredColors}" value="Black">Black</input></pre>
* @netui:tag name="checkBoxGroup" description="Groups a collection of CheckBoxOptions, and handles databinding of their values."
*/
public class CheckBoxGroup
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/CheckBoxOption.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/CheckBoxOption.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/CheckBoxOption.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/CheckBoxOption.java Mon May 16 09:42:11 2005
@@ -154,8 +154,8 @@
* @param defaultValue - the default value
* @jsptagref.attributedescription The boolean value or expression to be used as the default value.
* @jsptagref.databindable true
- * @jsptagref.attributesyntaxvalue <i>boolean_default_value</i>
- * @netui:attribute required="false" rtexprvalue="true"
+ * @jsptagref.attributesyntaxvalue <i>boolean_defaultValue</i>
+ * @netui:attribute required="false" rtexprvalue="true" type="boolean"
* description="Sets the default value."
*/
public void setDefaultValue(boolean defaultValue)
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Error.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Error.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Error.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Error.java Mon May 16 09:42:11 2005
@@ -78,7 +78,7 @@
* Set the key under which the error was stored (often the name of the form bean property associated with the error).
* @param key - the key under which the error was stored
* @jsptagref.attributedescription The key under which the error was stored (often the name of the form bean property associated with the error)
- * @jsptagref.databindable true
+ * @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_or_expression_key</i>
* @netui:attribute required="true" rtexprvalue="true"
* description="The key under which the error was stored (often the name of the form bean property associated with the error)"
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ErrorBaseTag.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ErrorBaseTag.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ErrorBaseTag.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ErrorBaseTag.java Mon May 16 09:42:11 2005
@@ -73,8 +73,8 @@
* @param bundleName - the bundle name
* @jsptagref.attributedescription The name of the message bundle, as defined in the page flow's
* Jpf.MessageBundle annotation. This defaults to org.apache.struts.action.Action.MESSAGES_KEY.
- * @jsptagref.databindable true
- * @jsptagref.attributesyntaxvalue <i>string_bundle_name</i>
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_bundleName</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="The name of the message bundle, as defined in the page flow's Jpf.MessageBundle annotation."
*/
@@ -89,8 +89,8 @@
* @param locale - the locale attribute name
* @jsptagref.attributedescription The name of the session attribute key for the user's locale.
* This defaults to org.apache.struts.action.Action.LOCALE_KEY.
- * @jsptagref.databindable true
- * @jsptagref.attributesyntaxvalue <i>string_bundle_name</i>
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_locale</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="The name of the session attribute key for the user's locale"
*/
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Form.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Form.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Form.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Form.java Mon May 16 09:42:11 2005
@@ -525,7 +525,7 @@
* contain anchors. Default is <code>false</code>.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>boolean_formSubmit</i>
- * @netui:attribute required="false" rtexprvalue="true"
+ * @netui:attribute required="false" rtexprvalue="true" type="boolean"
* description="Generate the form submit JavaScript even if the form does not contain anchors."
*/
public void setGenJavaScriptFormSubmit(boolean formSubmit)
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatTag.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatTag.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatTag.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatTag.java Mon May 16 09:42:11 2005
@@ -37,7 +37,7 @@
* Sets the language code for the locale.
* @param language - the language code
* @jsptagref.attributedescription Sets the language code for the locale.
- * @jsptagref.databindable
+ * @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_language</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the language code for the locale."
@@ -51,7 +51,7 @@
* Sets the country code for the locale.
* @param country - the country code
* @jsptagref.attributedescription Sets the country code for the locale.
- * @jsptagref.databindable
+ * @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_country</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the country code for the locale."
@@ -93,7 +93,7 @@
* @param pattern - the pattern to be used
* @jsptagref.attributedescription Sets the pattern to be used by this format tag.
* (See the tag description)
- * @jsptagref.databindable
+ * @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_pattern</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the pattern to be used by this FormatTag."
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlBaseTag.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlBaseTag.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlBaseTag.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlBaseTag.java Mon May 16 09:42:11 2005
@@ -73,7 +73,7 @@
* @param styleClass - the html style class.
* @jsptagref.attributedescription The style class (a style sheet selector).
* @jsptagref.databindable false
- * @jsptagref.attributesyntaxvalue <i>string_style_class</i>
+ * @jsptagref.attributesyntaxvalue <i>string_styleClass</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="The style class (a style sheet selector)."
*/
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlFocusBaseTag.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlFocusBaseTag.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlFocusBaseTag.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlFocusBaseTag.java Mon May 16 09:42:11 2005
@@ -35,7 +35,7 @@
* @param disabled - true or false or an expression
* @jsptagref.attributedescription Set the disable state either with the literal "true"
* or "false" or with an expression.
- * @jsptagref.databindable true
+ * @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>boolean_disabled</i>
* @netui:attribute required="false" rtexprvalue="true" type="boolean"
* description="Set the disable state either with the literal "true" or "false"
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlGroupBaseTag.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlGroupBaseTag.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlGroupBaseTag.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlGroupBaseTag.java Mon May 16 09:42:11 2005
@@ -180,7 +180,7 @@
* @param disabled - true or false or an expression
* @jsptagref.attributedescription Set the disable state either with the literal "true"
* or "false" or with an expression.
- * @jsptagref.databindable true
+ * @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>boolean_disabled</i>
* @netui:attribute required="false" rtexprvalue="true" type="boolean"
* description="Set the disable state either with the literal "true" or "false"
@@ -196,7 +196,7 @@
* or <code>vertical</code>. The default is <code>horizontal</code>.
* @param orientation - true or false or an expression
* @jsptagref.attributedescription Set the orientation of the resulting options group.
- * @jsptagref.databindable true
+ * @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_orientation</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Set the orientation of the resulting options group."
@@ -223,9 +223,9 @@
* Set whether repeating of contained options is on.
* @param repeater - the repeater value ("true" or "false")
* @jsptagref.attributedescription Set whether repeating of contained options is on.
- * @jsptagref.databindable true
+ * @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>boolean_repeater</i>
- * @netui:attribute required="false" rtexprvalue="true"
+ * @netui:attribute required="false" rtexprvalue="true" type="boolean"
* description="Set whether repeating of contained options is on."
*/
public void setRepeater(boolean repeater)
@@ -246,7 +246,7 @@
* Sets the style of the rendered html tag.
* @param style - the html style.
* @jsptagref.attributedescription Specifies style information for the current element.
- * @jsptagref.databindable true
+ * @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_style</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the style of the rendered html tag."
@@ -260,8 +260,8 @@
* Sets the style class of the rendered html tag.
* @param styleClass - the html style class.
* @jsptagref.attributedescription The style class (a style sheet selector).
- * @jsptagref.databindable true
- * @jsptagref.attributesyntaxvalue <i>string_style_class</i>
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_styleClass</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the style class of the rendered html tag."
*/
@@ -283,8 +283,8 @@
* Set the label style for each contained CheckBoxOption.
* @param labelStyle - the label style
* @jsptagref.attributedescription Set the label style for each contained CheckBoxOption.
- * @jsptagref.databindable true
- * @jsptagref.attributesyntaxvalue <i>string_label_style</i>
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_labelStyle</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Set the label style for each contained CheckBoxOption."
*/
@@ -306,8 +306,8 @@
* Set the label style class for each contained CheckBoxOption.
* @param labelStyleClass - the label style
* @jsptagref.attributedescription Set the label style class for each contained CheckBoxOption.
- * @jsptagref.databindable true
- * @jsptagref.attributesyntaxvalue <i>string_label_style_class</i>
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_labelStyleClass</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Set the label style class for each contained CheckBoxOption."
*/
@@ -322,8 +322,8 @@
* @param dataSource the data source
* @jsptagref.attributedescription An expression to be evaluated. It determines
* the source of populating data for the tag
- * @jsptagref.databindable true
- * @jsptagref.attributesyntaxvalue <i>string_datasource</i>
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_dataSource</i>
* @netui:attribute required="true"
* description="Sets the tag's data source."
*/
@@ -433,7 +433,7 @@
* Sets the default value (can be an expression).
* @param defaultValue - the default value
* @jsptagref.attributedescription The String literal or expression to be used as the default value.
- * @jsptagref.databindable true
+ * @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_or_expression_default</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="The String literal or expression to be used as the default value."
@@ -463,7 +463,7 @@
* @param optionsDataSource - the options datasource
* @jsptagref.attributedescription Sets the options datasource value (an expression).
* @jsptagref.databindable true
- * @jsptagref.attributesyntaxvalue <i>expression_options_datasource</i>
+ * @jsptagref.attributesyntaxvalue <i>expression_optionsDataSource</i>
* @netui:attribute required="false" rtexprvalue="true" type="java.lang.Object"
* description="Sets the options datasource value."
*/
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ImageAnchor.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ImageAnchor.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ImageAnchor.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ImageAnchor.java Mon May 16 09:42:11 2005
@@ -40,10 +40,11 @@
* An imageAnchor must have one of five attributes to correctly create the hyperlink:
* <ul>
* <li>action - an action invoked by clicking the hyperlink.</li>
- * <li>forward - a forward to redirect to.</li>
* <li>href - a URL to go to</li>
* <li>linkName - an internal place in the page to move to</li>
- * <li>page - The module-relative page URL to which this hyperlink will be rendered.</li>
+ * <li>clientAction - the action to run on the client</li>
+ * <li>tagId - the ID of the tag</li>
+ * <li>formSubmit - indicates whether or not the enclosing Form should be submitted</li>
* </ul>
* @jsptagref.tagdescription <p>
* Generates a hyperlink with a clickable image. Provides support for image rollovers.
@@ -52,28 +53,30 @@
* <blockquote>
* <ul>
* <li><code>action</code> - an action method invoked by clicking the hyperlink</li>
- * <li><code>forward</code> - a forward to redirect to</li>
* <li><code>href</code> - an URL to go to</li>
* <li><code>linkName</code> - an internal place in the page to move to</li>
- * <li><code>page</code> - the module-relative page URL to which this hyperlink will be rendered</li>
+ * <li><code>clientAction</code> - the action to run on the client</li>
+ * <li><code>tagId</code> - the ID of the tag</li>
+ * <li><code>formSubmit</code> - indicates whether or not the enclosing Form should be submitted</li>
* </ul>
* </blockquote>
*
* <p><b>JavaScript</b></p>
- * <p>If an <netui:imageAnchor> sets the <code>formSubmit</code> attribute to <code>true</code> and no
- * <code>onClick</code> attribute is set, the following JavaScript function will be written into the page.
- * The JavaScript function will be referenced by the <code>onclick</code> attribute of the generated image
- * anchor, and will cause the parent form to submit:<br/>
- * <pre> function submit[formname][formAction]Form() {
- * for(var i=0; i<document.forms.length; i++) {
- * if (document.forms[i].id == "[formAction]") {
+ * <p>If the <code>formSubmit</code> attribute is set to <code>true</code> and no
+ * <code>onClick</code> attribute is set, the following JavaScript function will be written to the HTML page.
+ * This JavaScript function will be referenced by the <code>onclick</code> attribute of the generated image
+ * anchor tag.</p>
+ * <pre>
+ * function anchor_submit_form(netuiName, newAction)
+ * {
+ * for (var i=0; i<document.forms.length; i++) {
+ * if (document.forms[i].id == netuiName) {
* document.forms[i].method = "POST";
- * document.forms[i].action = "[formAction]";
+ * document.forms[i].action = newAction;
* document.forms[i].submit();
- * }
- * }
- * }
- * </pre>
+ * }
+ * }
+ * }</pre>
* <p>It is possible to write a custom <code>onClick</code> JavaScript event handler that would
* do additional work, for example form validation, and still submit the form correctly. To
* accomplish this, reference a JavaScript function in the <code>onClick</code>
@@ -177,10 +180,14 @@
}
/**
- * Sets the property to specify the longdesc.
+ * Sets the property to specify a link to the the long description to supplement
+ * the short description in the <code>alt</code> attribute.
* @param longdesc - the longdesc.
+ * @jsptagref.attributedescription Specifies a link to the the long description.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_longdesc</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="Sets the property to specify the longdesc."
+ * description="Specifies a link to the the long description."
*/
public void setLongdesc(String longdesc)
{
@@ -307,8 +314,14 @@
* set. If this is not set, and <code>style</code> is set, then it will be applied to
* the image.
* @param imageStyle - the label style
+ * @jsptagref.attributedescription For legacy documents. Specifies style information for the
+ * contained image. When the tag library is running in legacy mode, this will override the
+ * <code>style</code> attribute. If this is not set, and <code>style</code> is set,
+ * then it will be applied to the image.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_imagestyle</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="Set the style for the contained image. "
+ * description="Set the style for the contained image."
*/
public void setImageStyle(String imageStyle)
{
@@ -321,6 +334,12 @@
* set. If this is not set, and <code>styleClass</code> is set, then it will be applied to
* the image.
* @param imageClass - the image class
+ * @jsptagref.attributedescription For legacy documents. The style class (a style sheet selector).
+ * When the tag library is running in legacy mode, this will override the <code>styleClass</code>
+ * attribute. If this is not set, and <code>styleClass</code> is set, then it will be applied to
+ * the image.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_imageclass</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Set the label style class for each contained image."
*/
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ImageButton.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ImageButton.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ImageButton.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ImageButton.java Mon May 16 09:42:11 2005
@@ -165,6 +165,9 @@
/**
* Sets the usemap of for the map.
* @param usemap - the tab index.
+ * @jsptagref.attributedescription Sets the usemap of for the map.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_usemap</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the usemap of for the map."
*/
@@ -176,6 +179,9 @@
/**
* Sets the ismap of for the map.
* @param ismap - the tab index.
+ * @jsptagref.attributedescription Sets the ismap of for the map.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_ismap</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the ismap of for the map."
*/
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Label.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Label.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Label.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Label.java Mon May 16 09:42:11 2005
@@ -61,6 +61,9 @@
/**
* Set the <code>for</code> attribute.
* @param forAttr - the for attribute.
+ * @jsptagref.attributedescription The value of this attribute matches a tagId on an form input and links the value to that control.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_forAttr</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="The value of this attribute matches a tagId on an form input and links the value to that control."
*/
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/LabelBase.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/LabelBase.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/LabelBase.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/LabelBase.java Mon May 16 09:42:11 2005
@@ -46,6 +46,11 @@
* all formatters will be applied, otherwise the default value will be output
* without being formatted.
* @param defaultValue - the default value
+ * @jsptagref.attributedescription The String literal or expression to be used as the
+ * default output. If the default value is an expression all formatters will be applied,
+ * otherwise the default value will be output without being formatted.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_or_expression_defaultValue</i>
* @netui:attribute required="false" rtexprvalue="true" type="java.lang.Object"
* description="Set the default value of this Label or Span."
*/
@@ -55,10 +60,13 @@
}
/**
- * Boolean indicating that if the if the defaultValue is displayed
- * should the formatter be applied. The default is "false" meaning
- * any formatters will not be applied.
+ * Boolean indicating whether the formatter should be applied to the defaultValue.
+ * The default is "false" meaning formatters will not be applied.
* @param formatDisplay Apply formatting to the default value.
+ * @jsptagref.attributedescription Boolean indicating whether the formatter should be applied
+ * to the defaultValue. The default is "false" meaning formatters will not be applied.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue boolean_formatDisplay
* @netui:attribute required="false" rtexprvalue="true"
* description="Apply formatting to the default value of this Label or Span."
*/
@@ -70,6 +78,9 @@
/**
* Sets the text of the Label.
* @param value - the Label value or expression.
+ * @jsptagref.attributedescription The String literal or expression used as the text of the Label.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_or_expression_output</i>
* @netui:attribute required="true" rtexprvalue="true" type="java.lang.Object"
* description="Sets the text of the Label or Span."
*/
@@ -86,6 +97,9 @@
* correctly. If this is <code>false</code> then white space will be
* output as it is found in the value.
* @param escapeWhiteSpace - boolean indicating if we are escaping for white space.
+ * @jsptagref.attributedescription Sets a boolean flag indicating if we will escape
+ * white space for HTML.
+ * @jsptagref.attributesyntaxvalue <i>boolean_escapeWhiteSpace</i>
* @netui:attribute required="false" rtexprvalue="true" type="boolean"
* description="Sets a boolean flag indicating if we will escape
* white space for HTML."
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Parameter.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Parameter.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Parameter.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Parameter.java Mon May 16 09:42:11 2005
@@ -78,7 +78,7 @@
* Sets the value of the URL parameter. This can be an expression.
* @param value - the parameter value.
* @jsptagref.attributedescription The value of the parameter. May be a literal or a data binding expression.
- * @jsptagref.databindable Read Only
+ * @jsptagref.databindable true
* @jsptagref.attributesyntaxvalue <i>string_or_expression_value</i>
* @netui:attribute required="true" rtexprvalue="true" type="java.lang.Object"
* description="The value of the parameter."
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RadioButtonGroup.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RadioButtonGroup.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RadioButtonGroup.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RadioButtonGroup.java Mon May 16 09:42:11 2005
@@ -41,7 +41,7 @@
* If RadioButtonGroup uses any Format tags, it must have those tags come before above any nested
* RadioButtonOption tags.
* @jsptagref.tagdescription Renders a collection of radiobutton options
- * and handles the data binding of their values.
+ * as <input type="radio"> and handles the data binding of their values.
*
* <p>The <netui:radioButtonGroup> tag can generate a set of
* radiobutton options in two ways:
@@ -63,25 +63,37 @@
* pointing the <netui:radioButtonGroup> tag at a HashMap
* (or any object that implements the {@link java.util.Map java.util.Map} interface).
*
- * <pre> public HashMap hashMap = new HashMap();
- * hashMap.put("value1", "Display Text 1");
- * hashMap.put("value2", "Display Text 2");
- * hashMap.put("value3", "Display Text 3");</pre>
+ * <p>For example, if you define a HashMap object and get method in the Controller file...
*
- * <p>To point the <netui:radioButtonGroup>
- * at the Map object use the <code>optionsDataSource</code> attribute.
+ * <pre> public HashMap hashMap = new HashMap();
*
- * <pre> <netui:radioButtonGroup
- * optionsDataSource="${pageFlow.hashMap}"></pre>
+ * protected HashMap getHashMap()
+ * {
+ * return hashMap;
+ * }
+ *
+ * protected void onCreate()
+ * {
+ * hashMap.put("value1", "Display Text 1");
+ * hashMap.put("value2", "Display Text 2");
+ * hashMap.put("value3", "Display Text 3");
+ * }</pre>
+ *
+ * ...point the <netui:radioButtonGroup>
+ * at the Map object using the <code>optionsDataSource</code> attribute.
+ *
+ * <pre> <netui:radioButtonGroup
+ * dataSource="actionForm.selection"
+ * optionsDataSource="${pageFlow.hashMap}"></pre>
*
* <p>In the generated radiobutton options, the display text and the
* submitted value can be made to differ. The HashMap keys will
* form the submitted values, while the HashMap entries will form
* the display texts.
*
- * <pre> <input type="radio" value="value1">Display Text 1</input>
- * <input type="radio" value="value2">Display Text 2</input>
- * <input type="radio" value="value3">Display Text 3</input></pre>
+ * <pre> <input type="radio" name="wlw-radio_button_group_key:{actionForm.selection}" value="value1">Display Text 1</input>
+ * <input type="radio" name="wlw-radio_button_group_key:{actionForm.selection}" value="value2">Display Text 2</input>
+ * <input type="radio" name="wlw-radio_button_group_key:{actionForm.selection}" value="value3">Display Text 3</input></pre>
*
* <p>Note that you can point the <netui:radioButtonGroup> tag at a
* String[] object. A set of radiobutton options will be generated,
@@ -99,51 +111,53 @@
* <netui:radioButtonOption value="value3">Display Text 3</netui:radioButtonOption><br>
* </netui:radioButtonGroup></pre>
*
- * <p><b>Submitting Radionbutton Options</b></p>
+ * <p><b>Submitting Data</b></p>
*
* <p>A <netui:radioButtonGroup> is submitted as a String value. Use the <code>dataSource</code> attribute
* to submit to a String object.
*
- * <pre> <netui:radioButtonGroup dataSource="actionForm.selection"></pre>
+ * <pre> <netui:radioButtonGroup dataSource="actionForm.selection"></pre>
*
* <p>In this case, the <netui:radioButtonGroup> submits to a String field of a Form Bean.
*
- * <pre> public static class ProcessDataForm extends FormData
- * {
- * private String selection;
- *
- * public void setSelection(String selection)
- * {
- * this.selection = selection;
- * }
- *
- * public String getSelection()
- * {
- * return this.selection;
- * }
- * }</pre>
- * @example In this sample, a <netui:radioButtonGroup> tag draws a set of options from a HashMap object.
- * <pre> <netui:radioButtonGroup
- * optionsDataSource="${pageFlow.hashMap}"
- * dataSource="actionForm.selection" /></pre>
- *
- * Assuming that the <code>optionsDataSource</code> attribute refers to the following HashMap object...
- *
- * <pre> public HashMap hashMap = new HashMap();
- * protected void onCreate()
- * {
- * hashMap.put("value1", "Display Text 1");
- * hashMap.put("value2", "Display Text 2");
- * hashMap.put("value3", "Display Text 3");
- * }</pre>
- *
- * ...then the following HTML will be generated in the browser...
- *
- * <pre> <netui:radioButtonGroup dataSource="actionForm.selection">
- * <netui:radioButtonOption value="value1">Display Text 1</netui:radioButtonOption><br>
- * <netui:radioButtonOption value="value2">Display Text 2</netui:radioButtonOption><br>
- * <netui:radioButtonOption value="value3">Display Text 3</netui:radioButtonOption><br>
- * </netui:radioButtonGroup></pre>
+ * <pre> public static class ProcessDataForm extends FormData
+ * {
+ * private String selection;
+ *
+ * public void setSelection(String selection)
+ * {
+ * this.selection = selection;
+ * }
+ *
+ * public String getSelection()
+ * {
+ * return this.selection;
+ * }
+ * }</pre>
+ * @example In this sample, the <netui:radioButtonGroup>
+ * submits data to the Form Bean field <code>preferredColors</code>.
+ *
+ * <pre> <netui:radioButtonGroup
+ * dataSource="actionForm.preferredColors"
+ * optionsDataSource="${pageFlow.colors}" /></pre>
+ *
+ * The <code>optionsDataSource</code> attribute points to a get method for a String[] on the Controller file:
+ *
+ * <pre> String[] colors = new String[] {"Red", "Blue", "Green", "Yellow", "White", "Black"};
+ *
+ * public String[] getColors()
+ * {
+ * return colors;
+ * }</pre>
+ *
+ * This automatically renders the appropriate set of radionbutton options:
+ *
+ * <pre> <input type="radio" name="wlw-radio_button_group_key:{actionForm.preferredColors}" value="Red">Red</input>
+ * <input type="radio" name="wlw-radio_button_group_key:{actionForm.preferredColors}" value="Blue">Blue</input>
+ * <input type="radio" name="wlw-radio_button_group_key:{actionForm.preferredColors}" value="Green">Green</input>
+ * <input type="radio" name="wlw-radio_button_group_key:{actionForm.preferredColors}" value="Yellow">Yellow</input>
+ * <input type="radio" name="wlw-radio_button_group_key:{actionForm.preferredColors}" value="White">White</input>
+ * <input type="radio" name="wlw-radio_button_group_key:{actionForm.preferredColors}" value="Black">Black</input></pre>
* @netui:tag name="radioButtonGroup" description="Defines a group of netui:radioButtonOption elements."
*/
public class RadioButtonGroup
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RewriteName.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RewriteName.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RewriteName.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RewriteName.java Mon May 16 09:42:11 2005
@@ -27,20 +27,18 @@
/**
* Allow a name, typically either an <code>id</code> or <code>name</code> attribute, to participate in URL
- * rewritting. Some containers such as WebLogic Portal rewrite names so they are unique.
- * This tag will cause the name to be made available from <code>getNetuiTagName</code>
+ * rewritting. Some containers rewrite name attributes so they are unique.
+ * This tag will cause the name to be made available from <code>lookupIdByTagId</code>
* JavaScript, which is output from the <netui:html> tag.
* @jsptagref.tagdescription Allows a name, typically either an <code>id</code> or <code>name</code> attribute,
- * to participate in URL
- * rewritting. Some containers such as WebLogic Portal rewrite name attributes
- * so they are unique.
- * This tag will cause the name to be made available from the <code>getNetuiTagName( tagId, tag )</code>
+ * to participate in URL rewritting. Some containers rewrite name attributes so they are unique.
+ * This tag will cause the name to be made available from the <code>lookupIdByTagId( id, tag )</code>
* JavaScript function.
- * @example In this sample, we are settting the id attribute of the span tag to 'foo'. The
+ * @example In this sample, we are setting the id attribute of the span tag to 'foo'. The
* actual value that will be rendered in the HTML may change depending on the
- * container where the web application resides. For example, a Portal container may change
- * render <span name="scope1_foo"> instead of <span name="scope1_foo">.
- * But the value 'foo' can be passed to <code>getNetuiTagName( tagId, tag )</code> to find the rendered
+ * container where the web application resides. For example, a Portal container may
+ * render <span name="scope1_foo"> instead of <span name="foo">.
+ * But the value 'foo' can be passed to <code>lookupIdByTagId( id, tag )</code> to find the rendered
* value of the name attribute.
*
* <pre> <span id="<netui:rewriteName name="foo"/>"></pre>
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RewriteURL.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RewriteURL.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RewriteURL.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RewriteURL.java Mon May 16 09:42:11 2005
@@ -39,21 +39,16 @@
import java.util.Map;
/**
- * Allow a name, typically either an id or name attribute, to participate in URL
- * rewritting. Some containers such as WebLogic Portal rewrite names so they are unique.
- * This tag will cause the name to be made available from <code>getNetuiTagName</code>
- * JavaScript which is output from the <netui:html> tag.
- * @jsptagref.tagdescription Allows a tag name, typically either an id or name attribute, to participate in URL
- * rewritting. Some containers such as WebLogic Portal rewrite names so they are unique.
- * This tag will cause the name to be made available from the <code>getNetuiTagName( tagId, tag )</code>
- * JavaScript function (which is written to the page by the <netui:html> tag).
- * @example In this sample, the id attribute of a <span> tag is set to 'foo'. The
- * actual value that will be written to the rendered HTML may change depending
- * on the application container. (Portal containers sometimes rewrite the id attributes
- * to ensure their uniqueness.) But the value 'foo' can be passed to
- * <code>getNetuiTagName( tagId, tag )</code> to find the
- * value of the id attribute actually rendered in the browser.
- * <pre> <span id="<netui:rewriteURL URL="foo"/>"></pre>
+ * Allow a URL to participate in rewritting. Some containers rewrite URLs.
+ * This tag will pass the URL attribute through the rewriters to generate a
+ * rewritten URL before it is output into the HTML stream.
+ * @jsptagref.tagdescription Allows a URL to participate in URL rewritting.
+ * Some containers rewrite URLs. This tag will pass the URL attribute through
+ * the rewriters to generate a rewritten URL before it is output into the HTML stream.
+ * @example In this sample, the URL attribute will be rewritten and output within
+ * the span tags. The actual value that will be written to the rendered HTML may
+ * change depending on the application container.
+ * <pre> <span>URL: <netui:rewriteURL URL="foo.do"/></span></pre>
* @netui:tag name="rewriteURL" description="Allows the URL Rewriter to rewrite the url attribute before it is output into the HTML stream."
*/
public class RewriteURL extends AbstractClassicTag implements IUrlParams
@@ -70,12 +65,12 @@
}
/**
- * Sets the name to be rewritten.
- * @param url - the parameter name.
+ * Sets the URL to be rewritten.
+ * @param url - the value of the URL that will be rewritten.
* @jsptagref.attributedescription The value of the URL that will be rewritten.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_url</i>
- * @netui:attribute required="false" rtexprvalue="true"
+ * @netui:attribute required="true" rtexprvalue="true"
* description="The value of the URL that will be rewritten."
*/
public void setURL(String url)
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Select.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Select.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Select.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Select.java Mon May 16 09:42:11 2005
@@ -66,46 +66,62 @@
* <p>You can dynamically generate a set of selectable options by
* pointing the <netui:select> tag at a String[].
*
- * <pre> public String[] _options = {"red", "green", "blue", "orange", "pink", "aqua", "black", "brown", "tan"};</pre>
+ * <pre> public String[] options = {"red", "green", "blue", "orange", "pink", "aqua", "black", "brown", "tan"};
*
- * <p>To point the <netui:select> tag
- * at the String[] object use the <code>optionsDataSource</code> attribute.
+ * public String[] getOptions()
+ * {
+ * return options;
+ * }</pre>
+ *
+ * <p>To point the <netui:select> tag at the String[] object use the
+ * <code>optionsDataSource</code> attribute.
*
- * <pre> <netui:select optionsDataSource="${pageFlow._options}"</pre>
+ * <pre> <netui:select dataSource="actionForm.selections"
+ * optionsDataSource="${pageFlow.options}"</pre>
*
- * Note that you can make the display value and the submitted value differ by pointing the <netui:select>
- * tag at a HashMap object.
+ * Note that you can make the display value and the submitted value differ by pointing the
+ * optionsDataSource attribute of the <netui:select> tag at a HashMap object.
* (Any object that implements the {@link java.util.Map java.util.Map} interface will work.)
*
- * <pre> public HashMap _hashMap = new HashMap();
+ * <pre> public HashMap optionsMap = new HashMap();
+ *
+ * protected HashMap getOptionsMap()
+ * {
+ * return optionsMap;
+ * }
*
* protected void onCreate()
* {
- * _hashMap.put("#ff3333", "red");
- * _hashMap.put("#3333ff", "blue");
- * _hashMap.put("#33ff33", "green");
+ * optionsMap.put("#ff3333", "red");
+ * optionsMap.put("#3333ff", "blue");
+ * optionsMap.put("#33ff33", "green");
* }</pre>
*
+ * Point the <netui:select> at the Map object using the <code>optionsDataSource</code> attribute.
+ *
+ * <pre> <netui:select dataSource="actionForm.selections"
+ * optionsDataSource="${pageFlow.optionsMap}"</pre>
+ *
* The following HTML will be generated.
*
- * <pre> <select size="3">
- * <option value="#3333ff">blue</option>
- * <option value="#33ff33">green</option>
- * <option value="#ff3333">red</option>
- * </select></pre>
+ * <pre> <select name="wlw-select_key:{actionForm.selections}">
+ * <option value="#3333ff">blue</option>
+ * <option value="#33ff33">green</option>
+ * <option value="#ff3333">red</option>
+ * </select></pre>
*
* <p><b>Statically Generated Options</b></p>
*
* <p>To statically generate selecable options, place a set of <netui:selectOption> tags inside
* the <netui:select> tag.
*
- * <pre> <netui:select dataSource="actionForm.selections" size="5">
- * <netui:selectOption value="red" />
- * <netui:selectOption value="blue" />
- * <netui:selectOption value="green" />
- * <netui:selectOption value="yellow" />
- * <netui:selectOption value="orange" />
- * </netui:select></pre>
+ * <pre> <netui:select dataSource="actionForm.selections" size="5">
+ * <netui:selectOption value="red" />
+ * <netui:selectOption value="blue" />
+ * <netui:selectOption value="green" />
+ * <netui:selectOption value="yellow" />
+ * <netui:selectOption value="orange" />
+ * </netui:select></pre>
*
* <p><b>Submitting Selections</b></p>
*
@@ -113,7 +129,7 @@
* <code>multiple</code> attribute is set to true. In the following example, the <code>dataSource</code>
* attribute points at a String[] object.
*
- * <pre> </netui:select dataSource="actionForm.selections"></pre>
+ * <pre> </netui:select dataSource="actionForm.selections"></pre>
*
* <p>In this case, the <netui:select> tag submits to a String[] field of a Form Bean.
*
@@ -132,12 +148,16 @@
* return this.selections;
* }
* }</pre>
+ *
+ * <p>Note that the <netui:select> element will dynamically generate option elements from
+ * the dataSource and the defaultValue attributes as well as optionsDataSource.
+ * The repeatingOrder attribute defines the order between these repeating types.<p>
* @example The following sample uses the <code>optionsDataSource</code> attribute to reference a
* dynamically generated dropdown list.
*
* <pre>
- * <netui:select dataSource="actionForm.selectedOption"
- * optionsDataSource="${actionForm.itemOptions}" />
+ * <netui:select dataSource="actionForm.selectedOption"
+ * optionsDataSource="${actionForm.itemOptions}" />
* </pre>
*
* <p>Assume that the <code>optionsDataSource</code> attribute refers to
@@ -146,7 +166,7 @@
* of <option> tags. HTML that is similar to the following will be
* rendered in the browser:</p>
*
- * <pre> <select>
+ * <pre> <select name="wlw-select_key:{actionForm.itemOptions}">
* <option value="633">Aurora Bridge</option>
* <option value="631">FA-18 fighter jet</option>
* <option value="635">Space Needle</option>
@@ -451,10 +471,13 @@
}
/**
- * Set whether repeating of contains options is on.
+ * Set whether repeating of contained options is on.
* @param repeater - the repeater value ("true" or "false")
+ * @jsptagref.attributedescription Set whether repeating of contained options is on.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>boolean_repeater</i>
* @netui:attribute required="false" rtexprvalue="true" type="boolean"
- * description="Set whether repeating of contains options is on."
+ * description="Set whether repeating of contained options is on."
*/
public void setRepeater(boolean repeater)
{
@@ -472,9 +495,18 @@
/**
* This method will set the order of the options generated in the select. It must contain a
- * common separated string of the options which match the <code>repeatingType</code> value.
- * These values are "Option", "Default", "DataSource", "Data", and "Null". The default order is
+ * comma separated string listing the order or the stages that the repeating types are processed.
+ * These values are "option", "dataSource", "default", and "null".
* @param order - comma separated ordering of items when there is a repeating select.
+ * @jsptagref.attributedescription Define the order of options generated for a repeating Select.
+ * It must contain a comma separated string listing the order or the stages that the repeating types
+ * are processed. These values are "option", "dataSource", "default", and "null". For example,
+ * <pre> repeatingOrder="dataSource,option"</pre>
+ *
+ * Then a <netui:selectOption> element could set the repeatingType attribute to "dataSource"
+ * while another is defined for "option".
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_order</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Define the order of options for a repeating Select"
*/
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/SelectOption.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/SelectOption.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/SelectOption.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/SelectOption.java Mon May 16 09:42:11 2005
@@ -112,8 +112,8 @@
/**
* Set if this option is disabled or not.
* @param disabled - "true" or "false"
- * @jsptagref.attributedescription Boolean. Determines whether the <option> is disabled.
- * @jsptagref.databindable Read Only
+ * @jsptagref.attributedescription Boolean value that determines whether the <option> is disabled.
+ * @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>boolean_disabled</i>
* @netui:attribute required="false" rtexprvalue="true" type="boolean"
* description="Determines whether the <option> is disabled."
@@ -136,10 +136,17 @@
}
/**
- * If the options is being used inside a repeating Select, this is the type of the option.
- * @param repeatingType - "Options", "Default", "DataSource", "Null", "Data"
+ * If the selectOption is being used inside a repeating {@link Select}, this defines the Select
+ * attribute used to generate the option elements.
+ * @param repeatingType Value of "option", "dataSource", "default", (for optionsDataSource, dataSource,
+ * and defaultValue attributes respectively) or "null"
+ * @jsptagref.attributedescription If the selectOption tag is being used inside a repeating Select, this
+ * defines the Select attribute used to generate the option elements. Values are "option", "dataSource", "default",
+ * (for optionsDataSource, dataSource, and defaultValue attributes respectively) and "null".
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_repeatingType</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="If the options is being used inside a repeating Select, this is the type of the option."
+ * description="If the selectOption is being used inside a repeating Select, this defines the Select attribute used to generate the option elements."
*/
public void setRepeatingType(String repeatingType)
{
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/javascript/ScriptHeader.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/javascript/ScriptHeader.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/javascript/ScriptHeader.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/javascript/ScriptHeader.java Mon May 16 09:42:11 2005
@@ -27,8 +27,13 @@
/**
* ScriptHeader will write the <script> and JavaScript includes into the HTML <head> tag.
- * @jsptagref.tagdescription ScriptHeader will write the <script> and JavaScript includes into the HTML <head> tag.
- * @netui:tag name="scriptHeader" body-content="empty" description="ScriptHeader will write the <script> and JavaScript includes into the HTML <head> tag."
+ * @jsptagref.tagdescription ScriptHeader will write the <script> and JavaScript includes into
+ * the HTML <head> tag.
+ *
+ * <p>This tag is required to be empty. It is also required when using the <netui:tree> element
+ * with the attribute runAtClient="true".
+ * @netui:tag name="scriptHeader" body-content="empty"
+ * description="ScriptHeader will write the <script> and JavaScript includes into the HTML <head> tag."
*/
public class ScriptHeader extends AbstractClassicTag
{
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/Tree.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/Tree.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/Tree.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/Tree.java Mon May 16 09:42:11 2005
@@ -48,10 +48,12 @@
* objects.
*
* <p>The tree is bound to a variable through the <code>dataSource</code> attribute.
- * If the bound variable exists, then the body content of this tag is not processed
- * and the tree is rendered. If the bound variable doesn't exist, we will process
- * the body and create the <code>TreeElement</code> tree structure and set the
- * the bound variable with the newly created tree.
+ * If the bound variable has been initialized, then the body content of this tag is not
+ * processed and the dataSource's version of the tree is rendered. If the bound variable
+ * has not been initialized, we will process the body, create the <code>TreeElement</code>
+ * tree structure, and set the bound variable with the newly created tree.
+ *
+ * A <netui:tree> tag cannot be nested within another <netui:tree> element.
*
* <p>This tag can automatically handle display icons for the tree nodes
* through the <code>imageRoot</code> attribute. If you point the
@@ -84,7 +86,7 @@
* used to uniquely identify a tree on the page.
*
* <pre> <netui:tree
- * dataSource="pageflow.myTree"
+ * dataSource="pageFlow.myTree"
* selectionAction="postback"
* tagId="myTree">
* <netui:treeItem expanded="true" >
@@ -149,6 +151,9 @@
* Sets the action used for expanding and contracting tree nodes. This action will be
* inherited by the <code>TreeElements</code> inside the tree.
* @param action - the action
+ * @jsptagref.attributedescription Sets the action used for expanding and contracting tree nodes.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_action</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the action used for expanding and contracting tree nodes."
*/
@@ -162,6 +167,9 @@
* Sets the action used for selecting tree nodes. This action will be
* inherited by the <code>TreeElements</code> inside the tree.
* @param action - the action
+ * @jsptagref.attributedescription Sets the action used when a tree node is selected.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_action</i>
* @netui:attribute required="true" rtexprvalue="true"
* description="Sets the action used when a tree node is selected."
*/
@@ -185,6 +193,9 @@
* Sets the target for a selection action. This can specify the name
* of the frame where the document is to be opened.
* @param target - the target for selection
+ * @jsptagref.attributedescription Sets the frame target used for selecting tree nodes.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_target</i>
* @netui:attribute rtexprvalue="true"
* description="Sets the frame target used for selecting tree nodes."
*/
@@ -199,6 +210,9 @@
* standard JavaScript lookup code unless <code>RenderTagIdLookup</code>
* is set to <code>true</code>.
* @param tagId - the tagId.
+ * @jsptagref.attributedescription Set the id of the tree. This appears on the containing <div>.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_tagId</i>
* @netui:attribute required="true" rtexprvalue="true"
* description="Set the id of the tree. This appears on the containing <div>."
*/
@@ -305,6 +319,9 @@
* Sets the default icon for TreeElements for a blank area of the tree.
* (Defaults to "folder.gif").
* @param itemIcon - the image name of the itemIcon
+ * @jsptagref.attributedescription Sets the default icon for TreeElements for a blank area of the tree.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_itemIcon</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the default icon for TreeElements for a blank area of the tree."
*/
@@ -423,8 +440,12 @@
* by JavaScript on the page. These expansion and contraction events will not call
* the server's expansion action.
* @param runAtClient
- * @netui:attribute required="false" rtexprvalue="false"
- * description="Indicate that base expand and contraction will happen on the client."
+ * @jsptagref.attributedescription Indicates whether that base expand and contraction will happen
+ * on the client.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>boolean_runAtClient</i>
+ * @netui:attribute required="false" rtexprvalue="false" type="boolean"
+ * description="Indicates whether that base expand and contraction will happen on the client."
*/
public void setRunAtClient(boolean runAtClient)
{
@@ -435,7 +456,10 @@
* This attribue will cause the content of labels to be escaped when the value if <i>true</i>.
* The default value is <i>false</i>.
* @param htmlEscape
- * @netui:attribute required="false"
+ * @jsptagref.attributedescription When true the content of labels will be escaped for HTML.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>boolean_htmlEscape</i>
+ * @netui:attribute required="false" type="boolean"
* description="When true the content of labels will be escaped for HTML."
*/
public void setEscapeForHtml(boolean htmlEscape)
@@ -448,7 +472,10 @@
* of the HTML tags this is automatically output. For the tree, because the tagId
* is a required attribute, we make javascript support optional.
* @param renderTagIdLookup
- * @netui:attribute required="false"
+ * @jsptagref.attributedescription Output the standard tagId to Id JavaScript.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>boolean_renderTagIdLookup</i>
+ * @netui:attribute required="false" type="boolean"
* description="Output the standard tagId to Id JavaScript."
*/
public void setRenderTagIdLookup(boolean renderTagIdLookup)
@@ -481,6 +508,10 @@
* Set the style of a tree element when is is selected. This results in a <code>style</code>
* attribute being generated for this tree node.
* @param selectedStyle
+ * @jsptagref.attributedescription Set the style of a tree element when is is selected. This results in a
+ * <code>style</code> attribute being generated for this tree node.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_selectedStyle</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Set the style of a tree element when is is selected. This results in a <code>style</code>
* attribute being generated for this tree node."
@@ -492,11 +523,15 @@
/**
* Set the style class of a tree element when is is disabled. A disabled element will have
- * a style can my be expanded/contracted, but my not be selected.
+ * a style that can be expanded/contracted, but may not be selected.
* @param disableStyleClass
+ * @jsptagref.attributedescription Set the style class of a tree element when is is disabled. A
+ * disabled element will have a style that may be expanded/contracted, but may not be selected.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_disableStyleClass</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Set the style class of a tree element when is is disabled. A disabled element will have
- * a style can my be expanded/contracted, but my not be selected."
+ * a style that can be expanded/contracted, but may not be selected."
*/
public void setDisabledStyleClass(String disableStyleClass)
@@ -506,11 +541,15 @@
/**
* Set the style of a tree element when is is disabled. A disabled element will have
- * a style can my be expanded/contracted, but my not be selected.
+ * a style that can be expanded/contracted, but may not be selected.
* @param disabledStyle
+ * @jsptagref.attributedescription Set the style of a tree element when is is disabled. A
+ * disabled element will have a style that can be expanded/contracted, but may not be selected.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_disableStyle</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Set the style of a tree element when is is disabled. A disabled element will have
- * a style can my be expanded/contracted, but my not be selected."
+ * a style that can be expanded/contracted, but may not be selected."
*/
public void setDisabledStyle(String disabledStyle)
{
@@ -521,6 +560,10 @@
* Set the style class of a tree element when is is selected. This results in a <code>class</code>
* attribute being generated for this tree node.
* @param selectedStyleClass
+ * @jsptagref.attributedescription Set the style class of a tree element when is is selected. This
+ * results in a <code>class</code> attribute being generated for this tree node.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_selectedStyleClass</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Set the style class of a tree element when is is selected. This results in a <code>class</code>
* attribute being generated for this tree node."
@@ -534,8 +577,12 @@
* Set the style class of a tree element when is is not selected. This results in a <code>style</code>
* attribute being generated for this tree node.
* @param unselectedStyle
+ * @jsptagref.attributedescription Set the style of a tree element when is is not selected. This
+ * results in a <code>style</code> attribute being generated for this tree node.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_unselectedStyle</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="Set the style class of a tree element when is is not selected. This results in a <code>style</code>
+ * description="Set the style of a tree element when is is not selected. This results in a <code>style</code>
* attribute being generated for this tree node."
*/
public void setUnselectedStyle(String unselectedStyle)
@@ -547,6 +594,10 @@
* Set the style class of a tree element when is is selected. This results in a <code>class</code>
* attribute being generated for this tree node.
* @param unselectedStyleClass
+ * @jsptagref.attributedescription Set the style class of a tree element when is is not selected. This
+ * results in a <code>style</code> attribute being generated for this tree node.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_unselectedStyleClasss</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Set the style class of a tree element when is is selected. This results in a <code>class</code>
* attribute being generated for this tree node."
@@ -559,6 +610,9 @@
/**
* Sets the <code>style</code> attribute of the tree.
* @param treeStyle - the style
+ * @jsptagref.attributedescription Sets the <code>style</code> attribute of the tree.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_treeStyle</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the <code>style</code> attribute of the tree."
*/
@@ -571,6 +625,9 @@
* Sets the <code>class</code> attribute of the tree. This will be set
* on the containing <div> for the tree.
* @param treeStyleClass - the style
+ * @jsptagref.attributedescription Sets the <code>class</code> attribute of the tree.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_treeStyleClass</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the <code>class</code> attribute of the tree."
*/
@@ -587,6 +644,10 @@
* the initial tree state and the bound variable will be set. In this situation
* the property must support both read and write.
* @param dataSource - the tree attribute name
+ * @jsptagref.attributedescription sets an expression which indentifies the TreeElement
+ * that represents the root of the tree.
+ * @jsptagref.databindable true
+ * @jsptagref.attributesyntaxvalue <i>string_dataSource</i>
* @netui:attribute required="true"
* description="Sets an expression which indentifies the TreeElement that represents the root of
* the tree."
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeContent.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeContent.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeContent.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeContent.java Mon May 16 09:42:11 2005
@@ -25,7 +25,19 @@
/**
* @jsptagref.tagdescription Set the additional content that will be displayed on the right of the label of a tree.
- * @netui:tag name="treeContent" body-content="scriptless" description="Set the additional content that will be displayed on the right of the label of a tree."
+ * @example The following example shows a <netui:tree> tag with both a
+ * child <netui:treeLabel> and <netui:treeContent> tag that form the
+ * label and the additional text displayed to the righ of the label for the
+ * root folder of the tree.
+ *
+ * <pre> <netui:tree dataSource="pageFlow.myTree" selectionAction="postback" tagId="myTree">
+ * <netui:treeItem expanded="true" >
+ * <netui:treeLabel>Root Folder</netui:treeLabel>
+ * <netui:treeContent>Content to right of label: Root Folder</netui:treeContent>
+ * </netui:treeItem>
+ * </netui:tree></pre>
+ * @netui:tag name="treeContent" body-content="scriptless"
+ * description="Set the additional content that will be displayed on the right of the label of a tree."
* @see org.apache.beehive.netui.tags.tree.Tree
* @see org.apache.beehive.netui.tags.tree.TreeElement
*/
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeHtmlAttribute.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeHtmlAttribute.java?rev=170407&r1=170406&r2=170407&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeHtmlAttribute.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/tree/TreeHtmlAttribute.java Mon May 16 09:42:11 2005
@@ -24,6 +24,18 @@
/**
* @jsptagref.tagdescription Set an attribute on the tree.
+ * @example The following example shows a <netui:tree> tag with both a
+ * child <netui:treeLabel> and <netui:treeHtmlAttribute> tag that form the
+ * label for the root folder of the tree. The <netui:treeHtmlAttribute>
+ * outputs the attribute <code>name="A1"</code> on the anchor element used for
+ * the selection link of the tree item.
+ *
+ * <pre> <netui:tree dataSource="pageFlow.myTree" selectionAction="postback" tagId="myTree">
+ * <netui:treeItem expanded="true" >
+ * <netui:treeLabel>Root Folder</netui:treeLabel>
+ <netui:treeHtmlAttribute attribute="name" value="A1" onSelectionLink="true"/>
+ * </netui:treeItem>
+ * </netui:tree></pre>
* @netui:tag name="treeHtmlAttribute" body-content="empty" description="Set an attribute on the tree."
* @see org.apache.beehive.netui.tags.tree.Tree
* @see org.apache.beehive.netui.tags.tree.TreeElement