Merge pull request #1991 from jakartaee/faces_issue_1972_deprecate_UI…

…Form_prependId 5.0: Deprecate h:form prependId
jakartaee · Jan 8, 2025 · ab296a6 · ab296a6
2 parents b3d869f + f6d6c4c
commit ab296a6
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/api/src/main/java/jakarta/faces/component/UIForm.java b/api/src/main/java/jakarta/faces/component/UIForm.java
@@ -70,7 +70,9 @@ enum PropertyKeys {
          * <p>
          * The prependId flag.
          * </p>
+         * @deprecated This attribute breaks the {@link UIComponent#findComponent(String)}.
          */
+        @Deprecated(since = "5.0", forRemoval = true)
         prependId,
 
         /**
@@ -146,7 +148,9 @@ public void setSubmitted(boolean submitted) {
      * Is the id prepended.
      *
      * @return <code>true</code> if it is, <code>false</code> otherwise.
+     * @deprecated This attribute breaks the {@link UIComponent#findComponent(String)}.
      */
+    @Deprecated(since = "5.0", forRemoval = true)
     public boolean isPrependId() {
         return (Boolean) getStateHelper().eval(PropertyKeys.prependId, true);
     }
@@ -155,7 +159,9 @@ public boolean isPrependId() {
      * Set whether the id should be prepended.
      * 
      * @param prependId <code>true</code> if it is, <code>false</code> otherwise.
+     * @deprecated This attribute breaks the {@link UIComponent#findComponent(String)}.
      */
+    @Deprecated(since = "5.0", forRemoval = true)
     public void setPrependId(boolean prependId) {
         getStateHelper().put(PropertyKeys.prependId, prependId);
     }

diff --git a/api/src/main/vdldoc/faces.html.taglib.xml b/api/src/main/vdldoc/faces.html.taglib.xml
@@ -3356,9 +3356,15 @@
         </attribute>
         <attribute>
             <description>
+                <![CDATA[
+                <strong>
+                    The use of this attribute has been <a href="https://github.com/jakartaee/faces/issues/1972">deprecated</a> in Faces 5.0, without replacement.
+                </strong>
+                <br/><br/>
                 Flag indicating whether or not this form should prepend its id
                 to its descendent's id during the clientId generation process.
                 If this flag is not set, the default value is true.
+                ]]>
             </description>
             <name>prependId</name>
             <required>false</required>