You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by lu...@apache.org on 2008/08/24 06:27:24 UTC
svn commit: r688445 - in
/myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component:
UICommand.java UIData.java UIGraphic.java UIInput.java UIOutput.java
Author: lu4242
Date: Sat Aug 23 21:27:23 2008
New Revision: 688445
URL: http://svn.apache.org/viewvc?rev=688445&view=rev
Log:
fix documentation
Modified:
myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UICommand.java
myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIData.java
myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIGraphic.java
myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIInput.java
myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIOutput.java
Modified: myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UICommand.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UICommand.java?rev=688445&r1=688444&r2=688445&view=diff
==============================================================================
--- myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UICommand.java (original)
+++ myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UICommand.java Sat Aug 23 21:27:23 2008
@@ -79,10 +79,12 @@
* accepts no parameters and has a String return value, called the action
* outcome, that identifies the next view displayed. The phase that this
* event is fired in can be controlled via the immediate attribute.
+ * </p>
* <p>
* If the value is a string literal, it is treated as a navigation outcome
* for the current view. This is functionally equivalent to a reference to
* an action method that returns the string literal.
+ * </p>
*
* @deprecated Use getActionExpression() instead.
*/
@@ -167,6 +169,7 @@
* During normal event processing, action methods and action listener methods are fired during the
* "invoke application" phase of request processing. If this attribute is set to "true", these methods
* are fired instead at the end of the "apply request values" phase.
+ * </p>
*/
@JSFProperty
public boolean isImmediate()
@@ -220,9 +223,11 @@
* an action method. An action method accepts no parameters and has a String return value, called the
* action outcome, that identifies the next view displayed. The phase that this event is fired in
* can be controlled via the immediate attribute.
+ * </p>
* <p>
* If the value is a string literal, it is treated as a navigation outcome for the current view. This
* is functionally equivalent to a reference to an action method that returns the string literal.
+ * </p>
*/
@JSFProperty(stateHolder = true, returnSignature = "java.lang.Object", jspName = "action")
public MethodExpression getActionExpression()
Modified: myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIData.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIData.java?rev=688445&r1=688444&r2=688445&view=diff
==============================================================================
--- myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIData.java (original)
+++ myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIData.java Sat Aug 23 21:27:23 2008
@@ -1029,7 +1029,7 @@
* An EL expression that specifies the data model that backs this table.
* <p>
* The value referenced by the EL expression can be of any type.
- * <p>
+ * </p>
* <ul>
* <li>A value of type DataModel is used directly.</li>
* <li>Array-like parameters of type array-of-Object, java.util.List, java.sql.ResultSet
@@ -1037,9 +1037,11 @@
* knows how to iterate over the elements.</li>
* <li>Other values are wrapped in a DataModel as a single row.</li>
* </ul>
+ * <p>
* Note in particular that unordered collections, eg Set are not supported. Therefore if the
* value expression references such an object then the table will be considered to contain just
* one element - the collection itself.
+ * </p>
*/
@JSFProperty
public Object getValue()
@@ -1097,6 +1099,7 @@
* <p>
* Specify zero to display all rows from the "first" row to the end
* of available data.
+ * </p>
*/
@JSFProperty
public int getRows()
@@ -1131,8 +1134,10 @@
* <p>
* During rendering of child components of this UIData, the variable with this name can be read to
* learn what the "rowData" object for the row currently being rendered is.
+ * </p>
* <p>
* This value must be a static value, ie an EL expression is not permitted.
+ * </p>
*/
@JSFProperty(literalOnly = true)
public String getVar()
Modified: myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIGraphic.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIGraphic.java?rev=688445&r1=688444&r2=688445&view=diff
==============================================================================
--- myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIGraphic.java (original)
+++ myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIGraphic.java Sat Aug 23 21:27:23 2008
@@ -100,6 +100,7 @@
* The URL of the image.
* <p>
* If the URL starts with a '/', it is relative to the context path of the web application.
+ * </p>
*/
@JSFProperty
public Object getValue()
Modified: myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIInput.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIInput.java?rev=688445&r1=688444&r2=688445&view=diff
==============================================================================
--- myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIInput.java (original)
+++ myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIInput.java Sat Aug 23 21:27:23 2008
@@ -516,6 +516,7 @@
* During normal event processing, action methods and action listener methods are fired during
* the "invoke application" phase of request processing. If this attribute is set to "true",
* these methods are fired instead at the end of the "apply request values" phase.
+ * </p>
*/
@JSFProperty
public boolean isImmediate()
@@ -545,8 +546,10 @@
* If this value is true and no input value is provided by a postback operation, then
* the "requiredMessage" text is registered as a FacesMessage for the request, and
* validation fails.
+ * </p>
* <p>
* Default value: false.
+ * </p>
*/
@JSFProperty(defaultValue = "false")
public boolean isRequired()
@@ -574,6 +577,7 @@
* Text to be displayed to the user as an error message when conversion of a
* submitted value to the target type fails.
* <p>
+ * </p>
*/
@JSFProperty
public String getConverterMessage()
@@ -628,8 +632,10 @@
* <p>
* The invoked method is expected to check the submitted value for this component, and if not
* acceptable then report a validation error for the component.
+ * </p>
* <p>
* The method is expected to have the prototype
+ * </p>
* <code>public void aMethod(FacesContext, UIComponent,Object)</code>
*
* @deprecated
@@ -715,6 +721,7 @@
* <p>
* The phase in which this method is invoked can be controlled via the immediate
* attribute.
+ * </p>
*
* @deprecated
*/
Modified: myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIOutput.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIOutput.java?rev=688445&r1=688444&r2=688445&view=diff
==============================================================================
--- myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIOutput.java (original)
+++ myfaces/core/trunk_1.2.x/api/src/main/java/javax/faces/component/UIOutput.java Sat Aug 23 21:27:23 2008
@@ -90,6 +90,7 @@
* specified, an instance of the converter type registered with that id is used. When this
* is an EL expression, the result of evaluating the expression must be an object that
* implements the Converter interface.
+ * </p>
*/
@JSFProperty
public Converter getConverter()