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/12 23:30:57 UTC
svn commit: r169890 -
/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html
Author: rich
Date: Thu May 12 14:30:55 2005
New Revision: 169890
URL: http://svn.apache.org/viewcvs?rev=169890&view=rev
Log:
This is a patch from Carlin Rogers to address a whole bunch of doc issues, including but not limited to http://issues.apache.org/jira/browse/BEEHIVE-637: netui tag libraries documentation needs updated tagId attribute descriptions
Thanks Carlin!
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/Button.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/CheckBox.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/Exceptions.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FileUpload.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/FormatDate.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatNumber.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatString.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/Hidden.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Html.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/HtmlDataSourceTag.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/HtmlOptionsDataSourceTag.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Image.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ParameterMap.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/RadioButtonOption.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/html/TextArea.java
incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/TextBox.java
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=169890&r1=169889&r2=169890&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 Thu May 12 14:30:55 2005
@@ -29,27 +29,29 @@
* <p>
* Generates a URL-encoded hyperlink to a specified URI.
* Also adds support for URL re-writing and JavaScript-based form submission.
- * An anchor must have one of five attributes to correctly create the hyperlink:
+ * An anchor must have one of the following 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>
* </p>
* @jsptagref.tagdescription <p>
* Generates an anchor that can link to another document or invoke an action method in the Controller file.
* The <netui:anchor> tag also supports JavaScript-based form submission and URL re-writing.
* <p>
- * An anchor must have one of five attributes to correctly create the hyperlink:
+ * An anchor must have one of the following attributes to correctly create the hyperlink:
* <blockquote>
* <ul>
* <li><code>action</code> - the action method invoked by clicking the hyperlink</li>
- * <li><code>forward</code> - the forward to redirect to</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>page</code> - the module-relative page URL to which this hyperlink will be rendered</li>
+ * <li><code>clientAction - 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>
@@ -59,9 +61,9 @@
* <pre>
* <netui:form action="formSubmit">
* Firstname:
- * <netui:textBox dataSource="{actionForm.firstname}"/>
+ * <netui:textBox dataSource="actionForm.firstname"/>
* Lastname:
- * <netui:textBox dataSource="{actionForm.lastname}"/>
+ * <netui:textBox dataSource="actionForm.lastname"/>
* <netui:anchor formSubmit="true">Submit</netui:anchor>
* </netui:form></pre>
* <p>If the <code>formSubmit</code> attribute is set to <code>true</code> and no
@@ -154,11 +156,11 @@
* Set a client action to run on the client. When set on an anchor, a NetUI JavaScript action
* will be run. This attribute may not be set if <code>href</code> or <code>action</code> is set.
* @param action an action to run on the client.
- * @jsptagref.attributedescription The client action.
+ * @jsptagref.attributedescription The action (NetUI JavaScript) to run on the client.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_client_action</i>
* @netui:attribute required="false" rtexprvalue="true" description="The client action."
- * description="The client action."
+ * description="The action (NetUI JavaScript) to run on the client."
*/
public void setClientAction(String action)
throws JspException
@@ -230,7 +232,7 @@
/**
* Sets <code>rel</code> attribute for the anchor.
* @param rel - the window target.
- * @jsptagref.attributedescription The rel.
+ * @jsptagref.attributedescription The relationship between the current document and the target Url.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_rel</i>
* @netui:attribute required="false" rtexprvalue="true"
@@ -244,7 +246,7 @@
/**
* Sets <code>rev</code> attribute for the anchor.
* @param rev - the window target.
- * @jsptagref.attributedescription The rev.
+ * @jsptagref.attributedescription Describes a reverse link from the anchor specified to the current document.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_rev</i>
* @netui:attribute required="false" rtexprvalue="true"
@@ -274,7 +276,7 @@
* This will set the text of the anchor. If there is body content, this
* will override that value.
* @param value - The text of the anchor.
- * @jsptagref.attributedescription Set the text of the anchor.
+ * @jsptagref.attributedescription Set the text of the anchor, overriding the body content.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_value</i>
* @netui:attribute required="false" rtexprvalue="true"
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=169890&r1=169889&r2=169890&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 Thu May 12 14:30:55 2005
@@ -11,6 +11,13 @@
/**
* @jsptagref.tagdescription
* 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.
+ * <pre><netui:image src="someDefaultPic.jpg" alt="the 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>
* @netui:tag name="area" description="Generates a URL-encoded area to a specified URI."
* @see Attribute
* @see java.lang.String
@@ -40,11 +47,11 @@
/**
* Sets the property to specify the alt text of the image.
* @param alt - the image alignment.
- * @jsptagref.attributedescription The alternative text of the image
- * @jsptagref.databindable Read Only
+ * @jsptagref.attributedescription Specifies alternate text for the area.
+ * @jsptagref.databindable true
* @jsptagref.attributesyntaxvalue <i>string_alt</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The alternative text of the image."
+ * description="Specifies alternate text for the area."
*/
public void setAlt(String alt)
{
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=169890&r1=169889&r2=169890&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 Thu May 12 14:30:55 2005
@@ -31,11 +31,11 @@
* <p>The following <netui:attribute> tags are rendered within the <span> tag (since
* the <netui:label> tag is rendered as a <span> tag in the browser.
*
- * <pre> <netui:label value="Some Text">
+ * <pre> <netui:span value="Some Text">
* <netui:attribute name="a" value="aVal" />
* <netui:attribute name="b" value="bVal" />
* <netui:attribute name="c" value="cVal" />
- * </netui:label></pre>
+ * </netui:span></pre>
*
* <p>The HTML rendered in the browser appears as follows.
*
@@ -43,7 +43,7 @@
*
* Note that the <code>value</code> attribute can be dynamically determined using a databinding expression.
*
- * <pre> <netui:attribute name="a" value="{pageFlow.aAttributeValue}" /></pre>
+ * <pre> <netui:attribute name="a" value="${pageFlow.aAttributeValue}" /></pre>
* @netui:tag name="attribute" body-content="empty" description="Add an attribute to the parent tag which be rendered."
*/
public class Attribute extends AbstractSimpleTag
@@ -92,6 +92,9 @@
/**
* 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.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=169890&r1=169889&r2=169890&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 Thu May 12 14:30:55 2005
@@ -37,7 +37,7 @@
* the warning are not displayed in production mode. The tag is intended
* for development use.
* @jsptagref.tagdescription Renders the set of error messages found during the process of resolving
- * data binding expressions ({pageFlow.firstname}, {request.firstname}, etc.).
+ * data binding expressions (${pageFlow.firstname}, ${requestScope.firstname}, etc.).
* The tag is intended
* for development use, not for error reporting in deployed applications.
* @example In this first sample, because the <netui:bindingUpdateErrors/> tag is unqualified,
@@ -46,7 +46,7 @@
* <pre><netui:bindingUpdateErrors /></pre>
* <p>In this next sample, only binding errors for the expression <code>{actionForm.firstName}</code>
* will be displayed on the page and the command window. </p>
- * <pre><netui:bindingUpdateErrors expression="{actionForm.firstName}"/></pre>
+ * <pre><netui:bindingUpdateErrors expression="${actionForm.firstName}"/></pre>
* @netui:tag name="bindingUpdateErrors" body-content="empty" description="Will display a message for all binding update errors that occurred when a form was posted."
*/
public class BindingUpdateErrors extends AbstractSimpleTag
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Button.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Button.java?rev=169890&r1=169889&r2=169890&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Button.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Button.java Thu May 12 14:30:55 2005
@@ -47,8 +47,8 @@
* <netui:button> tag must be enclosed in <netui:form...> ...
* </netui:form> tags. You can specify the action that the form will
* raise on the <netui:form> tag.
- * @jsptagref.tagdescription Renders an HTML button with the specified attributes. To
- * submit data or invoke a method on the Controller file, the
+ * @jsptagref.tagdescription Renders an <input type="button"> tag with the specified attributes.
+ * To submit data or invoke a method on the Controller file, the
* <netui:button> tag must a parent {@link Form} tag.
* The action attribute on the <netui:button> is for the purpose
* of overriding the action attribute on the enclosing <netui:form> tag.
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/CheckBox.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/CheckBox.java?rev=169890&r1=169889&r2=169890&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/CheckBox.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/CheckBox.java Thu May 12 14:30:55 2005
@@ -48,7 +48,7 @@
* <p>The <netui:checkBox> tag can be data bound to a boolean or Boolean type. For instance,
* the following <netui:checkBox> tag...
*
- * <pre> <netui:checkBox dataSource="{actionForm.checkBoxValue}"/></pre>
+ * <pre> <netui:checkBox dataSource="actionForm.checkBoxValue"/></pre>
*
* ...must be bound to a boolean or Boolean field in the Form Bean...
*
@@ -72,7 +72,7 @@
* action method <code>processData</code>.
* <pre> <netui:form action="processData">
* Do you want to be notified of special offers?
- * <netui:checkBox dataSource="{actionForm.wantsSpecialOffers}"/><br>
+ * <netui:checkBox dataSource="actionForm.wantsSpecialOffers"/><br>
* <netui:button value="Submit" type="submit"/>
* </netui:form></pre>
* @netui:tag name="checkBox" description="Generates a checkbox that binds to a form bean property or databound expression."
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=169890&r1=169889&r2=169890&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 Thu May 12 14:30:55 2005
@@ -49,8 +49,8 @@
* For example, if the <netui:checkBoxGroup> submits data to a Form Bean field...
*
* <pre> <netui:checkBoxGroup
- * dataSource="{actionForm.userSelections}"
- * optionsDataSource="{pageFlow.availableSelections}" /></pre>
+ * dataSource="actionForm.userSelections"
+ * optionsDataSource="${pageFlow.availableSelections}" /></pre>
*
* ...then the Form Bean field must be a String[] object...
*
@@ -75,15 +75,20 @@
* corresponding set of
* checkboxes will be genereated from the String[] object.
*
- * <p>For example, if you define a String[] object in the Controller file...
+ * <p>For example, if you define a String[] object and get method in the Controller file...
*
- * <pre> public String[] availableOptions = {"option1", "option2", "option3"};</pre>
+ * <pre> public String[] availableOptions = {"option1", "option2", "option3"};
*
- * ...and reference this String[] from the <code>optionDataSource</code> attribute...
+ * 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>
+ * dataSource="actionForm.userSelections"
+ * optionsDataSource="${pageFlow.availableSelections}" /></pre>
*
* ...then the appropriate checkboxes will be rendered in the browser.
*
@@ -104,12 +109,17 @@
* submits data to the Form Bean field <code>preferredColors</code>.
*
* <pre> <netui:checkBoxGroup
- * dataSource="{actionForm.preferredColors}"
- * optionsDataSource="{pageFlow.colors}" /></pre>
+ * dataSource="actionForm.preferredColors"
+ * optionsDataSource="${pageFlow.colors}" /></pre>
+ *
+ * The <code>optionsDataSource</code> attribute points to a get method for a String[] on the Controller file:
*
- * The <code>optionsDataSource</code> attribute points to a String[] on the Controller file:
+ * <pre> colors = new String[] {"Red", "Blue", "Green", "Yellow", "White", "Black"};
*
- * <pre> colors = new String[] {"Red", "Blue", "Green", "Yellow", "White", "Black"};</pre>
+ * public String[] getColors()
+ * {
+ * return colors;
+ * }</pre>
*
* This automatically renders the appropriate set of checkbox options within the <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=169890&r1=169889&r2=169890&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 Thu May 12 14:30:55 2005
@@ -41,7 +41,7 @@
* to the <code>processData</code> action method.
*
* <pre> <netui:form action="processData">
- * <netui:checkBoxGroup dataSource="{actionForm.data}" defaultValue="{actionForm.defaultChoices}">
+ * <netui:checkBoxGroup dataSource="actionForm.data" defaultValue="${actionForm.defaultChoices}">
* <netui:checkBoxOption value="wantSpecialCDOffers">Do you want to be notified of special CD offers?</netui:checkBoxOption><br>
* <netui:checkBoxOption value="wantSpecialDVDOffers">Do you want to be notified of special DVD offers?</netui:checkBoxOption><br>
* </netui:checkBoxGroup>
@@ -152,6 +152,9 @@
/**
* Sets the default value (can be an expression).
* @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"
* description="Sets the default value."
*/
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=169890&r1=169889&r2=169890&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 Thu May 12 14:30:55 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 Read Only
+ * @jsptagref.databindable true
* @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=169890&r1=169889&r2=169890&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 Thu May 12 14:30:55 2005
@@ -71,6 +71,10 @@
* {@link org.apache.beehive.netui.pageflow.annotations.Jpf.MessageBundle} annotation, where the error messages
* can be found. If this attribute is not set, the page flow's default message bundle is used.
* @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>
* @netui:attribute required="false" rtexprvalue="true"
* description="The name of the message bundle, as defined in the page flow's Jpf.MessageBundle annotation."
*/
@@ -83,8 +87,12 @@
/**
* Set the name of the locale attribute.
* @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>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The locale."
+ * description="The name of the session attribute key for the user's locale"
*/
public final void setLocale(String locale)
{
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Exceptions.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Exceptions.java?rev=169890&r1=169889&r2=169890&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Exceptions.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Exceptions.java Thu May 12 14:30:55 2005
@@ -84,6 +84,10 @@
/**
* Set whether or not the stack trace is being shown.
* @param showStackTrace - true or false depending on the setting desired
+ * @jsptagref.attributedescription Boolean. Determine if the stack trace is display only when dev mode
+ * is on. Default is <code>true</code>.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>boolean_showDevModeStackTrace</i>
* @netui:attribute required="false" rtexprvalue="true" type="boolean"
* description="Determine if the stack trace is display only when dev mode is on. Default is true."
*/
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FileUpload.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FileUpload.java?rev=169890&r1=169889&r2=169890&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FileUpload.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FileUpload.java Thu May 12 14:30:55 2005
@@ -53,7 +53,7 @@
*
* <pre> <netui:form action="uploadFile" <b>enctype="multipart/form-data"</b>>
* ...
- * <netui:fileUpload tagId="inputbox" dataSource="{actionForm.theFile}" />
+ * <netui:fileUpload tagId="inputbox" dataSource="actionForm.theFile" />
* ...
* </netui:form></pre>
*
@@ -85,28 +85,28 @@
* cannot be read back into the tag on postback.
* @example In the following example, note the <code>enctype</code> attribute of the
* enclosing <netui:form> tag.
- * <pre> <netui:form action="uploadFile" enctype="multipart/form-data">
- * <netui:fileUpload tagId="inputbox" dataSource="{actionForm.theFile}" />
- * <netui:button value="Upload File" />
- * </netui:form></pre>
+ * <pre> <netui:form action="uploadFile" enctype="multipart/form-data">
+ * <netui:fileUpload tagId="inputbox" dataSource="actionForm.theFile" />
+ * <netui:button value="Upload File" />
+ * </netui:form></pre>
*
* Note that the <netui:fileUpload> tag submits the file to Form Bean property <code>theFile</code>. This
* property must be of type <code>org.apache.struts.upload.FormFile</code>:
*
* <pre> public static class UploadFileForm extends FormData
- * {
- * private <b>org.apache.struts.upload.FormFile</b> theFile;
+ * {
+ * private <b>org.apache.struts.upload.FormFile</b> theFile;
+ *
+ * public void setTheFile(<b>org.apache.struts.upload.FormFile</b> theFile)
+ * {
+ * this.theFile = theFile;
+ * }
*
- * public void setTheFile(<b>org.apache.struts.upload.FormFile</b> theFile)
- * {
- * this.theFile = theFile;
- * }
- *
- * public <b>org.apache.struts.upload.FormFile</b> getTheFile()
- * {
- * return this.theFile;
- * }
- * }</pre>
+ * public <b>org.apache.struts.upload.FormFile</b> getTheFile()
+ * {
+ * return this.theFile;
+ * }
+ * }</pre>
* @netui:tag name="fileUpload" description="Upload a file from the client to the server."
*/
public class FileUpload extends HtmlDataSourceTag
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=169890&r1=169889&r2=169890&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 Thu May 12 14:30:55 2005
@@ -163,9 +163,9 @@
* action method in the Controller file when the form is submitted.
* <pre> <netui:form action="processData">
* Name:
- * <netui:textBox dataSource="{actionForm.name}"/>
+ * <netui:textBox dataSource="actionForm.name"/>
* Age:
- * <netui:textBox dataSource="{actionForm.age}"/>
+ * <netui:textBox dataSource="actionForm.age"/>
* <netui:button value="Submit" type="submit"/>
* </netui:form></pre>
*
@@ -193,7 +193,7 @@
* <pre>
* <netui:form action="Action" type="corp.Controller$NameBean"
* scope="session" name="nameBean">
- * Name: <netui:textBox dataSource="{actionForm.name}" />
+ * Name: <netui:textBox dataSource="actionForm.name" />
* <netui:button value="Submit"/>
* </netui:form></pre>
* @netui:tag name="form" description="Represents an input form, associated with a bean whose properties correspond to the various fields of the form."
@@ -518,6 +518,10 @@
* form contains anchors that are used to submit the form. This will make sure the JavaScript is
* always generated.
* @param formSubmit boolean value indicating that the form submit JavaScript should be generated. Default is false.
+ * @jsptagref.attributedescription Generate the form submit JavaScript even if the form does not
+ * contain anchors. Default is <code>false</code>.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>boolean_formSubmit</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Generate the form submit JavaScript even if the form does not contain anchors."
*/
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatDate.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatDate.java?rev=169890&r1=169889&r2=169890&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatDate.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatDate.java Thu May 12 14:30:55 2005
@@ -69,7 +69,7 @@
*
* <p>The <netui:formatDate> tag formats the output of its parent tag. For example:
*
- * <pre> <netui:content value="{pageContext.euroDate}">
+ * <pre> <netui:content value="${pageScope.euroDate}">
* <netui:formatDate pattern="dd-MM-yyyy" />
* </netui:content></pre>
*
@@ -179,7 +179,7 @@
* </ul>
* </blockquote>
* @example In this sample, the <netui:label> tag's output will be formatted to something like 08/29/1957.
- * <pre> <netui:label value="{pageContext.today}">
+ * <pre> <netui:label value="${pageScope.today}">
* <netui:formatDate pattern="MM/dd/yyyy" />
* </netui:label></pre>
* @netui:tag name="formatDate" body-content="empty" description="A formatter used to format dates."
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatNumber.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatNumber.java?rev=169890&r1=169889&r2=169890&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatNumber.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatNumber.java Thu May 12 14:30:55 2005
@@ -42,9 +42,9 @@
*
* <p>The <netui:formatNumber> tag formats the output of its parent tag. For example:
*
- * <pre> <netui:label value="{price}">
+ * <pre> <netui:span value="${pageFlow.price}">
* <netui:formatNumber country="FR" language="fr" type="currency" />
- * </netui:label></pre>
+ * </netui:span></pre>
*
* <p>The <code>pattern</code> attribute conforms to
* {@link java.text.DecimalFormat java.text.DecimalFormat} pattern syntax.
@@ -75,16 +75,9 @@
*
* <p>The <code>country</code> attribute takes an upper-case,
* two-letter code as defined by ISO-3166.
- * For a list of country codes see
- * <a href="{@docRoot}/../reference/refISO3166CountryCodes.html">
- * ISO-3166 Country Codes </a>
*
* <p>The <code>language</code> attribute takes a lower-case,
* two-letter code as defined by ISO-639.
- * For a list of
- * ISO-639 language codes see
- * <a href="{@docRoot}/../reference/refISO639LanguageCodes.html">
- * ISO-639 Language Codes </a>
* @example In this first example, the value "12345678" is formatted
* to 12,345,678.00.
* <pre> <netui:label value="12345678">
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatString.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatString.java?rev=169890&r1=169889&r2=169890&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatString.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/FormatString.java Thu May 12 14:30:55 2005
@@ -58,7 +58,7 @@
*
* <p>The <netui:formatString> tag formats the output of its parent tag. For example:
*
- * <pre> <netui:label value="{pageFlow.phone}">
+ * <pre> <netui:label value="${pageFlow.phone}">
* <netui:formatString pattern="phone number: (###) ###-####"/>
* </netui:label> </pre>
*
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=169890&r1=169889&r2=169890&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 Thu May 12 14:30:55 2005
@@ -36,6 +36,9 @@
/**
* Sets the language code for the locale.
* @param language - the language code
+ * @jsptagref.attributedescription Sets the language code for the locale.
+ * @jsptagref.databindable
+ * @jsptagref.attributesyntaxvalue <i>string_language</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the language code for the locale."
*/
@@ -47,6 +50,9 @@
/**
* Sets the country code for the locale.
* @param country - the country code
+ * @jsptagref.attributedescription Sets the country code for the locale.
+ * @jsptagref.databindable
+ * @jsptagref.attributesyntaxvalue <i>string_country</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the country code for the locale."
*/
@@ -85,6 +91,10 @@
/**
* Sets the pattern to be used by this FormatTag.
* @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.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/Hidden.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Hidden.java?rev=169890&r1=169889&r2=169890&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Hidden.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Hidden.java Thu May 12 14:30:55 2005
@@ -39,7 +39,7 @@
* (whatever is referenced by the <code>dataSource</code> attribute).
* The <code>dataInput</code> attribute may take a String literal or a data binding expression.
* @example In this sample, the Hidden tag is written using the value from the form bean's status property.
- * <pre><netui:hidden dataSource="{actionForm.status}" /></pre>
+ * <pre><netui:hidden dataSource="actionForm.status" /></pre>
* @netui:tag name="hidden" description="Generates a hidden tag with a given value."
*/
public class Hidden
@@ -97,7 +97,7 @@
* the <code>dataInput</code> attribute) and return the value to a new destination (whatever is
* referenced by the <code>dataSource</code> attribute).
* This attribute may take a String literal or a data binding expression.
- * @jsptagref.databindable Read Only
+ * @jsptagref.databindable true
* @jsptagref.attributesyntaxvalue <i>string_or_expression_dataInput</i>
* @netui:attribute required="false" rtexprvalue="true" type="java.lang.Object"
* description="The dataInput attribute overrides the dataSource attribute for the input of the value. "
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Html.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Html.java?rev=169890&r1=169889&r2=169890&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Html.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Html.java Thu May 12 14:30:55 2005
@@ -44,43 +44,6 @@
* left-to-right (LTR).
* <pre><netui:html dir="LTR" useLocale="true" /></pre>
*
- * <p><b>JavaScript</b></p>
- * <p>The <netui:html> tag writes out the following JavaScript functions:
- * <pre>
- * function getNetuiTagName(id) {
- * return netui_names[id]; }
- *
- * function getNetuiTagName(id, tag) {
- * if (scopeId == "")
- * return netui_names[id];
- * else
- * return netui_names[portletId__id]; }
- *
- * function getIdScope(tag) {
- * if (tag == null) return "";
- * if (tag.scopeId != null) return tag.scopeId;
- * return getIdScope(tag.parentElement); }
- *
- * results.append("\nfunction getNetuiTagName(id) {\n");
- * results.append("\treturn ");
- * results.append(NAMES_OBJECT);
- * results.append("[id]; }\n\n");
- *
- * results.append("\nfunction getNetuiTagName(id, tag) {\n");
- * results.append("\tvar scopeId = getIdScope(tag);\n");
- * results.append("\tif (scopeId == \"\")\n");
- * results.append("\t\treturn ");
- * results.append(NAMES_OBJECT);
- * results.append("[id];\n");
- * results.append("\telse\n\t\treturn ");
- * results.append(NAMES_OBJECT);
- * results.append("[portletId + \"__\" + id]; }\n\n");
- *
- * results.append("\nfunction getIdScope(tag) {\n");
- * results.append("\tif (tag == null) return \"\";\n");
- * results.append("\tif (tag.scopeId != null) return tag.scopeId;\n");
- * results.append("\treturn getIdScope(tag.parentElement);\n}\n\n");
- * </pre>
* @netui:tag name="html" description="Generates the html element and performs error handling within its body."
*/
public class Html extends ScriptContainer
@@ -164,6 +127,9 @@
/**
* Sets the dir value of the html.
* @param dir - "LTR" or "RTL"
+ * @jsptagref.attributedescription Specifies the direction of text. (<code>LTR | RTL</code>)
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_dir</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the dir value (ltr or rtl) of the html."
*/
@@ -184,6 +150,9 @@
/**
* Sets whether the default locale's language should be used.
* @param locale - true or false
+ * @jsptagref.attributedescription Sets whether the default locale's language should be used.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>boolean_locale</i>
* @netui:attribute required="false" rtexprvalue="true" type="boolean"
* description="Sets whether the default locale's language should be used."
*/
@@ -193,6 +162,11 @@
}
/**
+ * Set the document type (html4-loose or xhtml1-transitional) of the document.
+ * @jsptagref.attributedescription Set the document type (html4-loose or xhtml1-transitional) of the document.
+ * The default is html4-loose-quirks.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_doctype</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Set the document type (html4-loose or xhtml1-transitional) of the document."
*/
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=169890&r1=169889&r2=169890&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 Thu May 12 14:30:55 2005
@@ -54,11 +54,11 @@
/**
* Sets the style of the rendered html tag.
* @param style - the html style.
- * @jsptagref.attributedescription The style.
+ * @jsptagref.attributedescription Specifies style information for the current element.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_style</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The style."
+ * description="Specifies style information for the current element."
*/
public void setStyle(String style)
{
@@ -71,11 +71,11 @@
/**
* Sets the style class of the rendered html tag.
* @param styleClass - the html style class.
- * @jsptagref.attributedescription The style class.
+ * @jsptagref.attributedescription The style class (a style sheet selector).
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_style_class</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The style class."
+ * description="The style class (a style sheet selector)."
*/
public void setStyleClass(String styleClass)
{
@@ -94,7 +94,7 @@
* the rendered id value to ensure the uniqueness of
* id's on the page). In this case, the real id rendered
* in the browser may be looked up
- * through the JavaScript function getNetuiTagName( tagId, tag )</code>.
+ * through the JavaScript function <code>lookupIdByTagId( tagId, tag )</code>.
*
* <p>For example, assume that some tag's <code>tagId</code> attribute is set to <code>foo</code>.
*
@@ -102,10 +102,10 @@
*
* <p>Then the following JavaScript function will return the real id attribute rendered in the browser:
*
- * <pre> getNetuiTagName( "foo", this )</pre>
+ * <pre> lookupIdByTagId( "foo", this )</pre>
*
* <p>To get a <netui:form> element and all of its children elements in JavaScript, use
- * the same JavaScript function <code>getNetuiTagName( tagId, tag )</code>. For example,
+ * the same JavaScript function <code>lookupIdByTagId( tagId, tag )</code>. For example,
* assume that there is a <netui:form> whose
* tagId attribute is set to <code>bar</code>.
*
@@ -114,21 +114,16 @@
* <p>Then the following JavaScript function will return the <netui:form> element
* and its children (packaged as an array).
*
- * <pre> document[getNetuiTagName( "bar", this )]</pre>
+ * <pre> document[lookupIdByTagId( "bar", this )]</pre>
*
* <p>To retreive the value entered into a <netui:textBox> within the <netui:form> tag, use the following
* JavaScript expression.
*
- * <pre> document[getNetuiTagName("bar", this)][getNetuiTagName("foo", this)].value</pre>
+ * <pre> document[lookupIdByTagId("bar", this)][lookupIdByTagId("foo", this)].value</pre>
*
* <p>The second parameter ensures that the JavaScript function
* begins its search within the correct Portlet scope. Pass the
* JavaScript keyword <code>this</code> as the second parameter.
- *
- * For detailed information on using the function
- * <code>getNetuiTagName( tagId, tag )</code> see
- * <a href="{@docRoot}/../guide/netui/guide/conUsingJavaScript.html">
- * Using JavaScript in Page Flow and Portal Applications</a>.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_tagId</i>
* @netui:attribute required="false" rtexprvalue="true"
@@ -175,11 +170,12 @@
/**
* Sets the lang attribute for the HTML element.
* @param lang
- * @jsptagref.attributedescription The lang.
+ * @jsptagref.attributedescription Sets the language code for the base language of an
+ * element's attribute values and text content.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_lang</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The lang."
+ * description="Sets the language code for the base language of an element's attribute values and text content."
*/
public void setLang(String lang)
{
@@ -188,13 +184,13 @@
}
/**
- * Sets the lang attribute for the HTML element.
+ * Sets the dir attribute for the HTML element.
* @param dir
- * @jsptagref.attributedescription The dir.
+ * @jsptagref.attributedescription Specifies the direction of text. (<code>LTR | RTL</code>)
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_dir</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="The dir."
+ * description="Specifies the direction of text. (LTR | RTL)"
*/
public void setDir(String dir)
{
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlDataSourceTag.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlDataSourceTag.java?rev=169890&r1=169889&r2=169890&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlDataSourceTag.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlDataSourceTag.java Thu May 12 14:30:55 2005
@@ -51,7 +51,7 @@
* (1) draw populating data from the Form Bean's foo property and (2)
* submit user defined data to the same property.
*
- * <p> <code><netui:textBox dataSource="{actionForm.foo}" /></code>
+ * <p> <code><netui:textBox dataSource="actionForm.foo" /></code>
*
* <p>The <code>dataSource</code> attribute takes either a data binding expression or
* the name of a Form Bean property. In the
@@ -67,8 +67,8 @@
* the Controller file ( = JPF file). The following <netui-data:repeater>
* tag draws its data from myIterativeData.
*
- * <p> <code><netui-data:repeater dataSource="{pageFlow.myIterativeData}"></code>
- * @jsptagref.databindable Read / Write
+ * <p> <code><netui-data:repeater dataSource="pageFlow.myIterativeData"></code>
+ * @jsptagref.databindable true
* @jsptagref.attributesyntaxvalue <i>expression_datasource</i>
* @netui:attribute required="true"
* description="The <code>dataSource</code> attribute determines both
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=169890&r1=169889&r2=169890&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 Thu May 12 14:30:55 2005
@@ -33,6 +33,10 @@
* Set the disable state either with the literal "true" or "false"
* or with an expression.
* @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.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"
* or with an expression."
@@ -55,6 +59,9 @@
/**
* Sets the onBlur javascript event.
* @param onblur - the onBlur event.
+ * @jsptagref.attributedescription The onBlur JavaScript event.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_onBlur</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the onBlur javascript event."
*/
@@ -67,6 +74,9 @@
/**
* Sets the onFocus javascript event.
* @param onfocus - the onFocus event.
+ * @jsptagref.attributedescription The onFocus JavaScript event.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_onFocus</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the onFocus javascript event."
*/
@@ -79,6 +89,9 @@
/**
* Sets the onChange javascript event.
* @param onchange - the onChange event.
+ * @jsptagref.attributedescription The onChange JavaScript event.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_onChange</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the onChange javascript event."
*/
@@ -91,6 +104,9 @@
/**
* Sets the onSelect javascript event.
* @param onselect - the onSelect event.
+ * @jsptagref.attributedescription The onSelect JavaScript event.
+ * @jsptagref.databindable false
+ * @jsptagref.attributesyntaxvalue <i>string_onSelect</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the onSelect javascript event."
*/
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=169890&r1=169889&r2=169890&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 Thu May 12 14:30:55 2005
@@ -178,6 +178,10 @@
* Set the disable state either with the literal "true" or "false"
* or with an expression.
* @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.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"
* or with an expression."
@@ -191,6 +195,9 @@
* Set the orientation of the resulting options group. The layout will be either <code>horizontal</code>
* 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.attributesyntaxvalue <i>string_orientation</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Set the orientation of the resulting options group."
*/
@@ -213,10 +220,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 true
+ * @jsptagref.attributesyntaxvalue <i>boolean_repeater</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="Set whether repeating of contains options is on."
+ * description="Set whether repeating of contained options is on."
*/
public void setRepeater(boolean repeater)
{
@@ -235,6 +245,9 @@
/**
* 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.attributesyntaxvalue <i>string_style</i>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the style of the rendered html tag."
*/
@@ -246,6 +259,9 @@
/**
* 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>
* @netui:attribute required="false" rtexprvalue="true"
* description="Sets the style class of the rendered html tag."
*/
@@ -266,6 +282,9 @@
/**
* 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>
* @netui:attribute required="false" rtexprvalue="true"
* description="Set the label style for each contained CheckBoxOption."
*/
@@ -286,6 +305,9 @@
/**
* 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>
* @netui:attribute required="false" rtexprvalue="true"
* description="Set the label style class for each contained CheckBoxOption."
*/
@@ -298,6 +320,10 @@
/**
* Sets the tag's data source (can be an expression).
* @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>
* @netui:attribute required="true"
* description="Sets the tag's data source."
*/
@@ -317,8 +343,7 @@
}
//********************************** IDataAccessProvider Interface ******************************
- // setDataSource is implemented by the HtmlDataSourceTag class
- // getDataSource is implemented by the HtmlDataSourceTag class
+ // getDataSource is implemented above
/**
* Get the current index in this iteration. This should be a
@@ -407,8 +432,11 @@
/**
* 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.attributesyntaxvalue <i>string_or_expression_default</i>
* @netui:attribute required="false" rtexprvalue="true"
- * description="Sets the default value."
+ * description="The String literal or expression to be used as the default value."
*/
public void setDefaultValue(Object defaultValue)
throws JspException
@@ -433,6 +461,9 @@
/**
* Sets the options datasource value (an expression).
* @param optionsDataSource - the options datasource
+ * @jsptagref.attributedescription Sets the options datasource value (an expression).
+ * @jsptagref.databindable true
+ * @jsptagref.attributesyntaxvalue <i>expression_options_datasource</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/HtmlOptionsDataSourceTag.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlOptionsDataSourceTag.java?rev=169890&r1=169889&r2=169890&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlOptionsDataSourceTag.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/HtmlOptionsDataSourceTag.java Thu May 12 14:30:55 2005
@@ -33,6 +33,9 @@
/**
* Sets the options datasource value (an expression).
* @param optionsDataSource - the options datasource
+ * @jsptagref.attributedescription Sets the options datasource value (an expression).
+ * @jsptagref.databindable true
+ * @jsptagref.attributesyntaxvalue <i>expression_options_datasource</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/Image.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Image.java?rev=169890&r1=169889&r2=169890&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Image.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/Image.java Thu May 12 14:30:55 2005
@@ -36,9 +36,9 @@
/**
* Generates an image with the specified attributes. Image ignores its
* body content.
- * @jsptagref.tagdescription Renders an HTML <image> tag with specified attributes.
+ * @jsptagref.tagdescription Renders an HTML <img> tag with specified attributes.
* @example In this sample, an Image shows "friends.jpg" at 150 x 175 pixels, with the id "Friends".
- * <pre><netui:image src="friends.jpg" id="Friends" height="150" width="175" /></pre>
+ * <pre><netui:image src="friends.jpg" tagId="Friends" height="150" width="175" /></pre>
* @netui:tag name="image" description="Places an image file type on your page."
*/
public class Image extends HtmlBaseTag
@@ -114,10 +114,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)
{
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ParameterMap.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ParameterMap.java?rev=169890&r1=169889&r2=169890&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ParameterMap.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/ParameterMap.java Thu May 12 14:30:55 2005
@@ -53,7 +53,7 @@
*
* <pre> <netui:anchor href="http://www.google.com/search">
* Search Greek language web sites updated in the last three months with the query "Socrates".
- * <netui:parameterMap map="{pageFlow.hashMap}"/>
+ * <netui:parameterMap map="${pageFlow.hashMap}"/>
* </netui:anchor></pre>
*
* <p>The URL produced appears as follows:
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=169890&r1=169889&r2=169890&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 Thu May 12 14:30:55 2005
@@ -72,7 +72,7 @@
* at the Map object use the <code>optionsDataSource</code> attribute.
*
* <pre> <netui:radioButtonGroup
- * optionsDataSource="{pageFlow.hashMap}"></pre>
+ * 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
@@ -93,7 +93,7 @@
* <p>To statically generate radiobutton options, place a set of <netui:radioButtonOption> tags inside
* the <netui:radioButtonGroup> tag.
*
- * <pre> <netui:radioButtonGroup dataSource="{actionForm.selection}">
+ * <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>
@@ -104,7 +104,7 @@
* <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.
*
@@ -124,8 +124,8 @@
* }</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>
+ * optionsDataSource="${pageFlow.hashMap}"
+ * dataSource="actionForm.selection" /></pre>
*
* Assuming that the <code>optionsDataSource</code> attribute refers to the following HashMap object...
*
@@ -139,7 +139,7 @@
*
* ...then the following HTML will be generated in the browser...
*
- * <pre> <netui:radioButtonGroup dataSource="{actionForm.selection}">
+ * <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>
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RadioButtonOption.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RadioButtonOption.java?rev=169890&r1=169889&r2=169890&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RadioButtonOption.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/RadioButtonOption.java Thu May 12 14:30:55 2005
@@ -34,7 +34,7 @@
* @example In this example, three radiobuttons are generated in the browser.
*
* <pre> <netui:form action="processData">
- * <netui:radioButtonGroup dataSource="{actionForm.selection}">
+ * <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>
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=169890&r1=169889&r2=169890&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 Thu May 12 14:30:55 2005
@@ -71,7 +71,7 @@
* <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 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.
@@ -99,7 +99,7 @@
* <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">
+ * <pre> <netui:select dataSource="actionForm.selections" size="5">
* <netui:selectOption value="red" />
* <netui:selectOption value="blue" />
* <netui:selectOption value="green" />
@@ -113,7 +113,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.
*
@@ -136,8 +136,8 @@
* 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
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=169890&r1=169889&r2=169890&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 Thu May 12 14:30:55 2005
@@ -41,7 +41,7 @@
* or any object that implements {@link java.util.Map java.util.Map}.
* @example The following sample generates a set of <option> tags.
* <pre> <netui:form action="submit">
- * <netui:select dataSource="{actionForm.selections}" size="5">
+ * <netui:select dataSource="actionForm.selections" size="5">
* <netui:selectOption value="red" />
* <netui:selectOption value="blue" />
* <netui:selectOption value="green" />
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/TextArea.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/TextArea.java?rev=169890&r1=169889&r2=169890&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/TextArea.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/TextArea.java Thu May 12 14:30:55 2005
@@ -37,8 +37,8 @@
* description property. If the submitted value is NULL the default value is specified
* by the Page Flow's
* defaultDescription property.
- * <pre> <netui:textArea dataSource="{actionForm.description}"
- * defaultValue="{pageFlow.defaultDescription}"
+ * <pre> <netui:textArea dataSource="actionForm.description"
+ * defaultValue="${pageFlow.defaultDescription}"
* cols="25" rows="3" /></pre>
* @netui:tag name="textArea" description="Renders a databound TextArea with the given attributes."
*/
Modified: incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/TextBox.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/TextBox.java?rev=169890&r1=169889&r2=169890&view=diff
==============================================================================
--- incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/TextBox.java (original)
+++ incubator/beehive/trunk/netui/src/tags-html/org/apache/beehive/netui/tags/html/TextBox.java Thu May 12 14:30:55 2005
@@ -34,8 +34,8 @@
* @jsptagref.tagdescription Renders an HTML <input type="text"> tag.
* @example In this sample, a <netui:textBox> reads from and writes to the Form Bean's firstname property.
* If the submitted text is NULL, the default value is specified by the Page Flow's firstName property.
- * <pre> <netui:textBox dataSource="{actionForm.firstName}"
- * defaultValue="{pageFlow.defaultFirstName}"
+ * <pre> <netui:textBox dataSource="actionForm.firstName"
+ * defaultValue="${pageFlow.defaultFirstName}"
* size="20" /></pre>
* @netui:tag name="textBox" description="Renders a databound TextBox with the given attributes."
*/