You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by aw...@apache.org on 2007/07/30 20:34:19 UTC

svn commit: r561084 - in /myfaces/trinidad/trunk/trinidad: trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponentBase.java trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/Component.xml

Author: awiner
Date: Mon Jul 30 11:34:18 2007
New Revision: 561084

URL: http://svn.apache.org/viewvc?view=rev&rev=561084
Log:
Improve Javadoc and tagdoc for the ID attribute to make the required syntax clearer.

Modified:
    myfaces/trinidad/trunk/trinidad/trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponentBase.java
    myfaces/trinidad/trunk/trinidad/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/Component.xml

Modified: myfaces/trinidad/trunk/trinidad/trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponentBase.java
URL: http://svn.apache.org/viewvc/myfaces/trinidad/trunk/trinidad/trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponentBase.java?view=diff&rev=561084&r1=561083&r2=561084
==============================================================================
--- myfaces/trinidad/trunk/trinidad/trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponentBase.java (original)
+++ myfaces/trinidad/trunk/trinidad/trinidad-api/src/main/java/org/apache/myfaces/trinidad/component/UIXComponentBase.java Mon Jul 30 11:34:18 2007
@@ -286,6 +286,9 @@
   }
 
 
+  /**
+   * Gets the identifier for the component.
+   */
   @Override
   public String getId()
   {
@@ -293,6 +296,15 @@
   }
 
 
+  /**
+   * Sets the identifier for the component.  The identifier
+   * must follow a subset of the syntax allowed in HTML:
+   * <ul>
+   * <li>Must not be a zero-length String.</li>
+   * <li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
+   * <li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
+   * </ul>
+   */
   @Override
   public void setId(String id)
   {

Modified: myfaces/trinidad/trunk/trinidad/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/Component.xml
URL: http://svn.apache.org/viewvc/myfaces/trinidad/trunk/trinidad/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/Component.xml?view=diff&rev=561084&r1=561083&r2=561084
==============================================================================
--- myfaces/trinidad/trunk/trinidad/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/Component.xml (original)
+++ myfaces/trinidad/trunk/trinidad/trinidad-build/src/main/resources/META-INF/maven-faces-plugin/components/javax/faces/Component.xml Mon Jul 30 11:34:18 2007
@@ -26,7 +26,13 @@
     <component-type>javax.faces.Component</component-type>
     <component-class>javax.faces.component.UIComponent</component-class>
     <property>
-      <description>the identifier for the component
+      <description><![CDATA[<html>the identifier for the component.  The identifier
+must follow a subset of the syntax allowed in HTML:
+<ul>
+<li>Must not be a zero-length String.</li>
+<li>First character must be an ASCII letter (A-Za-z) or an underscore ('_').</li>
+<li>Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').</li>
+</ul></html>]]>
       </description>
       <property-name>id</property-name>
       <property-class>java.lang.String</property-class>