You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@click.apache.org by sa...@apache.org on 2010/04/10 18:26:04 UTC
svn commit: r932754 - in /click/trunk/click:
documentation/xdocs/src/docbook/click/chapter-controls.xml
framework/src/org/apache/click/control/AbstractControl.java
framework/src/org/apache/click/control/Field.java
Author: sabob
Date: Sat Apr 10 16:26:03 2010
New Revision: 932754
URL: http://svn.apache.org/viewvc?rev=932754&view=rev
Log:
javadoc
Modified:
click/trunk/click/documentation/xdocs/src/docbook/click/chapter-controls.xml
click/trunk/click/framework/src/org/apache/click/control/AbstractControl.java
click/trunk/click/framework/src/org/apache/click/control/Field.java
Modified: click/trunk/click/documentation/xdocs/src/docbook/click/chapter-controls.xml
URL: http://svn.apache.org/viewvc/click/trunk/click/documentation/xdocs/src/docbook/click/chapter-controls.xml?rev=932754&r1=932753&r2=932754&view=diff
==============================================================================
--- click/trunk/click/documentation/xdocs/src/docbook/click/chapter-controls.xml (original)
+++ click/trunk/click/documentation/xdocs/src/docbook/click/chapter-controls.xml Sat Apr 10 16:26:03 2010
@@ -438,9 +438,9 @@ production-error-message=
<sect2 id="accessing-messages" remap="h3">
<title>Accessing Messages</title>
- <para>Field classes support a hierarchy of resource bundles for displaying
+ <para>Controls support a hierarchy of resource bundles for displaying
validation error messages and display messages. These localized messages
- can be accessed through the Field methods:
+ can be accessed through the AbstractControl methods:
</para>
<itemizedlist>
@@ -451,12 +451,7 @@ production-error-message=
</listitem>
<listitem>
<para>
- <ulink url="../../click-api/org/apache/click/control/AbstractControl.html#getMessage(java.lang.String,%20java.lang.Object)">getMessage(String, Object)</ulink>
- </para>
- </listitem>
- <listitem>
- <para>
- <ulink url="../../click-api/org/apache/click/control/AbstractControl.html#getMessage(java.lang.String,%20java.lang.Object[])">getMessage(String, Object[])</ulink>
+ <ulink url="../../click-api/org/apache/click/control/AbstractControl.html#getMessage(java.lang.String,%20java.lang.Object...)">getMessage(String, Object...)</ulink>
</para>
</listitem>
<listitem>
@@ -467,11 +462,13 @@ production-error-message=
<listitem>
<para>
<ulink url="../../click-api/org/apache/click/control/Field.html#setErrorMessage(java.lang.String)">setErrorMessage(String)</ulink>
+ - this method is defined on the Field class
</para>
</listitem>
<listitem>
<para>
<ulink url="../../click-api/org/apache/click/control/Field.html#setErrorMessage(java.lang.String,%20java.lang.Object)">setErrorMessage(String, Object)</ulink>
+ - this method is defined on the Field class
</para>
</listitem>
</itemizedlist>
Modified: click/trunk/click/framework/src/org/apache/click/control/AbstractControl.java
URL: http://svn.apache.org/viewvc/click/trunk/click/framework/src/org/apache/click/control/AbstractControl.java?rev=932754&r1=932753&r2=932754&view=diff
==============================================================================
--- click/trunk/click/framework/src/org/apache/click/control/AbstractControl.java (original)
+++ click/trunk/click/framework/src/org/apache/click/control/AbstractControl.java Sat Apr 10 16:26:03 2010
@@ -48,18 +48,11 @@ import org.apache.click.util.MessagesMap
* to make it easier for developers to create their own controls.
* <p/>
* Subclasses are expected to at least override {@link #getTag()}
- * to differentiate the control. However some controls does not map cleanly
+ * to differentiate the control. However some controls do not map cleanly
* to an html <em>tag</em>, in which case you can override
* {@link #render(org.apache.click.util.HtmlStringBuffer)} for complete control
* over the output.
* <p/>
- * Subclasses are also expected to provide a default no-arg constructor <tt>if</tt>
- * the control deploys its JavaScript and CSS resources through Click's
- * {@link org.apache.click.Control#onDeploy(javax.servlet.ServletContext)} mechanism.
- * However if JavaScript and CSS resources are deployed through Click's
- * <a href="../../../../user-guide/html/ch04s03.html#deploying-custom-resources">convention based</a>
- * mechanism, a default constructor is <tt>not</tt> needed.
- * <p/>
* Below is an example of creating a new control called MyField:
* <pre class="prettyprint">
* public class MyField extends AbstractControl {
@@ -120,7 +113,7 @@ import org.apache.click.util.MessagesMap
* Also see {@link org.apache.click.Control} javadoc for an explanation of the
* Control execution sequence.
*
- * <h3><a name="message-resources"></a>Message Resources and Internationalization(i18n)</h3>
+ * <h3><a name="message-resources"></a>Message Resources and Internationalization (i18n)</h3>
*
* Controls support a hierarchy of resource bundles for displaying messages.
* These localized messages can be accessed through the methods:
@@ -130,6 +123,9 @@ import org.apache.click.util.MessagesMap
* <li>{@link #getMessage(String, Object...)}</li>
* <li>{@link #getMessages()}</li>
* </ul>
+ *
+ * The order in which localized messages resolve are descibed in the
+ * <a href="../../../../../user-guide/html/ch03s04.html#message-resolution">user guide</a>.
*/
public abstract class AbstractControl implements Control {
Modified: click/trunk/click/framework/src/org/apache/click/control/Field.java
URL: http://svn.apache.org/viewvc/click/trunk/click/framework/src/org/apache/click/control/Field.java?rev=932754&r1=932753&r2=932754&view=diff
==============================================================================
--- click/trunk/click/framework/src/org/apache/click/control/Field.java (original)
+++ click/trunk/click/framework/src/org/apache/click/control/Field.java Sat Apr 10 16:26:03 2010
@@ -33,9 +33,9 @@ import org.apache.click.util.HtmlStringB
* rendering of the contained fields. All Form field controls must extend this
* abstract class.
*
- * <h3>Field Processing</h3>
+ * <h3><a name="field-processing"></a>Field Processing</h3>
*
- * <h4>Post Requests</h4>
+ * <h4><a name="post-requests"></a>Post Requests</h4>
*
* When processing POST requests forms typically invoke the {@link #onProcess()}
* method on all its fields. The Field <tt>onProcess()</tt> method is used
@@ -85,12 +85,12 @@ import org.apache.click.util.HtmlStringB
* method, and possibly the <tt>bindRequestValue()</tt> method, to provide their
* own behaviour.
*
- * <h4>Get Requests</h4>
+ * <h4><a name="get-requests"></a>Get Requests</h4>
*
* When processing GET requests a Page's Form will typically perform no
* processing and simply render itself and its Fields.
*
- * <h3>Rendering</h3>
+ * <h3><a name="rendering"></a>Rendering</h3>
*
* Field subclasses must override the {@link #render(org.apache.click.util.HtmlStringBuffer)}
* method to enable themselves to be rendered as HTML. With the increasing use of
@@ -105,7 +105,7 @@ import org.apache.click.util.HtmlStringB
* To assist with rendering valid HTML Field subclasses can use the
* {@link org.apache.click.util.HtmlStringBuffer} class.
*
- * <h3><a name="message-resources"></a>Message Resources and Internationalization(i18n)</h3>
+ * <h3><a name="message-resources"></a>Message Resources and Internationalization (i18n)</h3>
*
* Fields support a hierarchy of resource bundles for displaying validation
* error messages and display messages. These localized messages can be accessed