From 41cd243ea25417da5f6d682b4d10f6e723999e8c Mon Sep 17 00:00:00 2001 From: Alwin Joseph <44426046+alwin-joseph@users.noreply.github.com> Date: Tue, 8 Feb 2022 20:24:08 +0530 Subject: [PATCH] add javadoc assertions for faces 4.0 --- .../JakartaFacesJavadocAssertions.html | 125688 +++++++++++++++ ...artaServerFacesJavadocAssertions_3.0.html} | 0 ...tions.xml => JSFJavadocAssertions_2.3.xml} | 0 .../docs/jsf/JSFJavadocAssertions_4.0.xml | 66452 ++++++++ 4 files changed, 192140 insertions(+) create mode 100644 install/jsf/docs/assertions/JakartaFacesJavadocAssertions.html rename install/jsf/docs/assertions/{JakartaServerFacesJavadocAssertions.html => JakartaServerFacesJavadocAssertions_3.0.html} (100%) rename internal/docs/jsf/{JSFJavadocAssertions.xml => JSFJavadocAssertions_2.3.xml} (100%) create mode 100644 internal/docs/jsf/JSFJavadocAssertions_4.0.xml diff --git a/install/jsf/docs/assertions/JakartaFacesJavadocAssertions.html b/install/jsf/docs/assertions/JakartaFacesJavadocAssertions.html new file mode 100644 index 0000000000..357b71c07c --- /dev/null +++ b/install/jsf/docs/assertions/JakartaFacesJavadocAssertions.html @@ -0,0 +1,125688 @@ + + + + + JavaDoc Assertion Detail + + + +
+
+

+ Jakarta Server Faces - 4.0.0 +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Totals + + Total + + Active + + Deprecated + + Removed +
+ + # of Assertions + + + 6129 + + 4040 + + 45 + + 2044 +
+ + # of Required Assertions + + + 6129 + + 4040 + + 45 + + 2044 +
+ + # of Optional Assertions + + + 0 + + 0 + + 0 + + 0 +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ID + + Return + + Method/Field + + Description + + Required + + Deprecated + + Testable +
+ JSF:JAVADOC:1 + + FacesException + + jakarta.faces.FacesException.FacesException +
+
+
+ Construct a new exception with no detail message or root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2 + + FacesException + + jakarta.faces.FacesException.FacesException +
+ ( + String + ) +
+
+ Construct a new exception with the specified detail message and no root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3 + + FacesException + + jakarta.faces.FacesException.FacesException +
+ ( + Throwable + ) +
+
+ Construct a new exception with the specified root cause. The detail message will be set + to (cause == null ? null : cause.toString() + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4 + + FacesException + + jakarta.faces.FacesException.FacesException +
+ ( + String + , +
+ Throwable + ) +
+
+ Construct a new exception with the specified detail message and root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5 + + Throwable + + jakarta.faces.FacesException.getCause +
+
+
+ Return the cause of this exception, or null if the cause is nonexistent or unknown. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:7 + + Object + + jakarta.faces.FactoryFinder.getFactory +
+ ( + String + ) + +
+ throws + FacesException +
+
+
+ if the web application class loader cannot be identified + + true + + +
+
+
+ true +
+ JSF:JAVADOC:12 + + void + + jakarta.faces.FactoryFinder.releaseFactories +
+
+ throws + FacesException +
+
+
+ if the web application class loader cannot be identified + + true + + +
+
+
+ true +
+ JSF:JAVADOC:15 + + Application + + jakarta.faces.application.Application.Application +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:33 + + Application + + jakarta.faces.application.ApplicationFactory.getApplication +
+
+
+ Create (if needed) and return an Application instance for this web application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:34 + + void + + jakarta.faces.application.ApplicationFactory.setApplication +
+ ( + Application + ) +
+
+ Replace the Application instance that will be returned for this web application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:37 + + NavigationHandler + + jakarta.faces.application.NavigationHandler.NavigationHandler +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:91 + + UICommand + + jakarta.faces.component.UICommand.UICommand +
+
+
+ Create a new UICommand instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:207 + + void + + jakarta.faces.component.UIComponent.encodeBegin +
+ ( + FacesContext + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs while rendering + + true + + +
+
+
+ true +
+ JSF:JAVADOC:210 + + void + + jakarta.faces.component.UIComponent.encodeChildren +
+ ( + FacesContext + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs while rendering + + true + + +
+
+
+ true +
+ JSF:JAVADOC:213 + + void + + jakarta.faces.component.UIComponent.encodeEnd +
+ ( + FacesContext + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs while rendering + + true + + +
+
+
+ true +
+ JSF:JAVADOC:234 + + String + + jakarta.faces.component.UIComponent.getRendererType +
+
+
+ Return the Renderer type for this UIComponent (if any). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:238 + + boolean + + jakarta.faces.component.UIComponent.isRendered +
+
+
+ Return true if this component (and its children) should be rendered during the Render + Response phase of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:270 + + void + + jakarta.faces.component.UIComponent.setRendered +
+ ( + boolean + ) +
+
+ Set the rendered property of this UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:271 + + void + + jakarta.faces.component.UIComponent.setRendererType +
+ ( + String + ) +
+
+ Set the Renderer type for this UIComponent, or null for components that render + themselves. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:302 + + void + + jakarta.faces.component.UIComponentBase.encodeBegin +
+ ( + FacesContext + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs while rendering + + true + + +
+
+
+ true +
+ JSF:JAVADOC:305 + + void + + jakarta.faces.component.UIComponentBase.encodeChildren +
+ ( + FacesContext + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs while rendering + + true + + +
+
+
+ true +
+ JSF:JAVADOC:308 + + void + + jakarta.faces.component.UIComponentBase.encodeEnd +
+ ( + FacesContext + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs while rendering + + true + + +
+
+
+ true +
+ JSF:JAVADOC:329 + + String + + jakarta.faces.component.UIComponentBase.getRendererType +
+
+
+ Return the Renderer type for this UIComponent (if any). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:333 + + boolean + + jakarta.faces.component.UIComponentBase.isRendered +
+
+
+ Return true if this component (and its children) should be rendered during the Render + Response phase of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:365 + + void + + jakarta.faces.component.UIComponentBase.setRendered +
+ ( + boolean + ) +
+
+ Set the rendered property of this UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:366 + + void + + jakarta.faces.component.UIComponentBase.setRendererType +
+ ( + String + ) +
+
+ Set the Renderer type for this UIComponent, or null for components that render + themselves. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:376 + + UIForm + + jakarta.faces.component.UIForm.UIForm +
+
+
+ Create a new UIForm instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:474 + + UIGraphic + + jakarta.faces.component.UIGraphic.UIGraphic +
+
+
+ Create a new UIGraphic instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:589 + + UIInput + + jakarta.faces.component.UIInput.UIInput +
+
+
+ Create a new UIInput instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:803 + + UIOutput + + jakarta.faces.component.UIOutput.UIOutput +
+
+
+ Create a new UIOutput instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:900 + + UIPanel + + jakarta.faces.component.UIPanel.UIPanel +
+
+
+ Create a new UIPanel instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1003 + + String + + jakarta.faces.component.UIParameter.getName +
+
+
+ Return the optional parameter name for this parameter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1005 + + void + + jakarta.faces.component.UIParameter.setName +
+ ( + String + ) +
+
+ Set the optional parameter name for this parameter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1006 + + UIParameter + + jakarta.faces.component.UIParameter.UIParameter +
+
+
+ Create a new UIParameter instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1111 + + UISelectBoolean + + jakarta.faces.component.UISelectBoolean.UISelectBoolean +
+
+
+ Create a new UISelectBoolean instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1222 + + String + + jakarta.faces.component.UISelectItem.getItemDescription +
+
+
+ Return the description for this selection item. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1223 + + String + + jakarta.faces.component.UISelectItem.getItemLabel +
+
+
+ Return the localized label for this selection item. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1226 + + void + + jakarta.faces.component.UISelectItem.setItemDescription +
+ ( + String + ) +
+
+ Set the description for this selection item. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1227 + + void + + jakarta.faces.component.UISelectItem.setItemLabel +
+ ( + String + ) +
+
+ Set the localized label for this selection item. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1438 + + UISelectMany + + jakarta.faces.component.UISelectMany.UISelectMany +
+
+
+ Create a new UISelectMany instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1562 + + UISelectOne + + jakarta.faces.component.UISelectOne.UISelectOne +
+
+
+ Create a new UISelectOne instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1695 + + ResponseStream + + jakarta.faces.context.FacesContext.getResponseStream +
+
+
+ Return the ResponseStream to which components should direct their binary output. Within + a given response, components can use either the ResponseStream or the ResponseWriter, but not both. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1696 + + ResponseWriter + + jakarta.faces.context.FacesContext.getResponseWriter +
+
+
+ Return the ResponseWriter to which components should direct their character-based + output. Within a given response, components can use either the ResponseStream or the ResponseWriter, + but not both. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1705 + + void + + jakarta.faces.context.FacesContext.setResponseStream +
+ ( + ResponseStream + ) +
+
+ Set the ResponseStream to which components should direct their binary output. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1707 + + void + + jakarta.faces.context.FacesContext.setResponseWriter +
+ ( + ResponseWriter + ) +
+
+ Set the ResponseWriter to which components should direct their character-based output. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1749 + + ResponseStream + + jakarta.faces.context.ResponseStream.ResponseStream +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:1760 + + void + + jakarta.faces.context.ResponseWriter.endDocument +
+
+
+ Write whatever text should end a response. If there is an open element that has been + created by a call to startElement(), that element will be closed first. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1761 + + void + + jakarta.faces.context.ResponseWriter.endDocument +
+
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1763 + + void + + jakarta.faces.context.ResponseWriter.endElement +
+ ( + String + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1765 + + ResponseWriter + + jakarta.faces.context.ResponseWriter.ResponseWriter +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:1766 + + void + + jakarta.faces.context.ResponseWriter.startDocument +
+
+
+ Write whatever text should begin a response. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1767 + + void + + jakarta.faces.context.ResponseWriter.startDocument +
+
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1776 + + void + + jakarta.faces.context.ResponseWriter.writeComment +
+ ( + Object + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1787 + + void + + jakarta.faces.context.ResponseWriter.writeText +
+ ( + char[] + , +
+ int + , +
+ int + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1811 + + String + + jakarta.faces.convert.Converter.getAsString +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ Convert the specified model object value, which is associated with the specified + UIComponent, into a String that is suitable for being included in the response generated during the + Render Response phase of the request processing lifeycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1814 + + ConverterException + + jakarta.faces.convert.ConverterException.ConverterException +
+
+
+ Construct a new exception with no detail message or root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1815 + + ConverterException + + jakarta.faces.convert.ConverterException.ConverterException +
+ ( + String + ) +
+
+ Construct a new exception with the specified detail message and no root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1816 + + ConverterException + + jakarta.faces.convert.ConverterException.ConverterException +
+ ( + Throwable + ) +
+
+ Construct a new exception with the specified root cause. The detail message will be set + to (cause == null ? null : cause.toString() + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1817 + + ConverterException + + jakarta.faces.convert.ConverterException.ConverterException +
+ ( + String + , +
+ Throwable + ) +
+
+ Construct a new exception with the specified detail message and root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1896 + + void + + jakarta.faces.event.ActionListener.processAction +
+ ( + ActionEvent + ) +
+
+ Invoked when the action described by the specified ActionEvent occurs. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1899 + + FacesEvent + + jakarta.faces.event.FacesEvent.FacesEvent +
+ ( + UIComponent + ) +
+
+ Construct a new event object from the specified source component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1900 + + UIComponent + + jakarta.faces.event.FacesEvent.getComponent +
+
+
+ Return the source UIComponent that sent this event. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1902 + + int + + jakarta.faces.event.PhaseId.compareTo +
+ ( + Object + ) +
+
+ Compare this PhaseId instance to the specified one. Returns a negative integer, zero, + or a positive integer if this object is less than, equal to, or greater than the specified object. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1903 + + int + + jakarta.faces.event.PhaseId.getOrdinal +
+
+
+ Return the ordinal value of this PhaseId instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1904 + + String + + jakarta.faces.event.PhaseId.toString +
+
+
+ Return a String representation of this PhaseId instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1913 + + void + + jakarta.faces.lifecycle.Lifecycle.execute +
+ ( + FacesContext + ) + +
+ throws + FacesException +
+
+
+ if thrown during the execution of the request processing lifecycle + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1916 + + Lifecycle + + jakarta.faces.lifecycle.Lifecycle.Lifecycle +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:1920 + + void + + jakarta.faces.lifecycle.LifecycleFactory.addLifecycle +
+ ( + String + , +
+ Lifecycle + ) +
+
+ Register a new Lifecycle instance, associated with the specified lifecycleId, to be + supported by this LifecycleFactory. This method may be called at any time, and makes the + corresponding Lifecycle instance available throughout the remaining lifetime of this web + application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1923 + + Lifecycle + + jakarta.faces.lifecycle.LifecycleFactory.getLifecycle +
+ ( + String + ) +
+
+ Create (if needed) and return a Lifecycle instance for the specified lifecycle + identifier. The set of available lifecycle identifiers is available via the getLifecycleIds() + method. Each call to getLifecycle() for the same lifecycleId, from within the same web application, + must return the same Lifecycle instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1926 + + Iterator + + jakarta.faces.lifecycle.LifecycleFactory.getLifecycleIds +
+
+
+ Return an Iterator over the set of lifecycle identifiers supported by this factory. + This set must include the value specified by LifecycleFactory.DEFAULT_LIFECYCLE. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1936 + + void + + jakarta.faces.render.Renderer.encodeBegin +
+ ( + FacesContext + , +
+ UIComponent + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs while rendering + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1938 + + void + + jakarta.faces.render.Renderer.encodeChildren +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Render the child components of this UIComponent, following the rules described for + encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if + the rendersChildren property of this component is true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1939 + + void + + jakarta.faces.render.Renderer.encodeChildren +
+ ( + FacesContext + , +
+ UIComponent + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs while rendering + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1941 + + void + + jakarta.faces.render.Renderer.encodeEnd +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Render the ending of the current state of the specified UIComponent, following the + rules described for encodeBegin() to acquire the appropriate value to be rendered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1942 + + void + + jakarta.faces.render.Renderer.encodeEnd +
+ ( + FacesContext + , +
+ UIComponent + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs while rendering + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1960 + + Renderer + + jakarta.faces.render.Renderer.Renderer +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:1980 + + RenderKit + + jakarta.faces.render.RenderKit.RenderKit +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2001 + + DoubleRangeValidator + + jakarta.faces.validator.DoubleRangeValidator.DoubleRangeValidator +
+
+
+ Construct a Validator with no preconfigured limits. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2002 + + DoubleRangeValidator + + jakarta.faces.validator.DoubleRangeValidator.DoubleRangeValidator +
+ ( + double + ) +
+
+ Construct a Validator with the specified preconfigured limit. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2003 + + DoubleRangeValidator + + jakarta.faces.validator.DoubleRangeValidator.DoubleRangeValidator +
+ ( + double + , +
+ double + ) +
+
+ Construct a Validator with the specified preconfigured limits. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2008 + + void + + jakarta.faces.validator.DoubleRangeValidator.setMaximum +
+ ( + double + ) +
+
+ Set the maximum value to be enforced by this Validator. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2010 + + void + + jakarta.faces.validator.DoubleRangeValidator.setMinimum +
+ ( + double + ) +
+
+ Set the minimum value to be enforced by this Validator. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2018 + + LengthValidator + + jakarta.faces.validator.LengthValidator.LengthValidator +
+
+
+ Construct a Validator with no preconfigured limits. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2019 + + LengthValidator + + jakarta.faces.validator.LengthValidator.LengthValidator +
+ ( + int + ) +
+
+ Construct a Validator with the specified preconfigured limit. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2020 + + LengthValidator + + jakarta.faces.validator.LengthValidator.LengthValidator +
+ ( + int + , +
+ int + ) +
+
+ Construct a Validator with the specified preconfigured limits. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2021 + + void + + jakarta.faces.validator.LengthValidator.setMaximum +
+ ( + int + ) +
+
+ Set the maximum length to be enforced by this Validator. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2023 + + void + + jakarta.faces.validator.LengthValidator.setMinimum +
+ ( + int + ) +
+
+ Set the minimum length to be enforced by this Validator. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2031 + + LongRangeValidator + + jakarta.faces.validator.LongRangeValidator.LongRangeValidator +
+
+
+ Construct a Validator with no preconfigured limits. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2032 + + LongRangeValidator + + jakarta.faces.validator.LongRangeValidator.LongRangeValidator +
+ ( + long + ) +
+
+ Construct a Validator with the specified preconfigured limit. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2033 + + LongRangeValidator + + jakarta.faces.validator.LongRangeValidator.LongRangeValidator +
+ ( + long + , +
+ long + ) +
+
+ Construct a Validator with the specified preconfigured limits. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2034 + + void + + jakarta.faces.validator.LongRangeValidator.setMaximum +
+ ( + long + ) +
+
+ Set the maximum value to be enforced by this Validator. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2036 + + void + + jakarta.faces.validator.LongRangeValidator.setMinimum +
+ ( + long + ) +
+
+ Set the minimum value to be enforced by this Validator. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2040 + + RequiredValidator + + jakarta.faces.validator.RequiredValidator.RequiredValidator +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2087 + + void + + jakarta.faces.webapp.FacesServlet.destroy +
+
+
+ Release all resources acquired at startup time. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2088 + + FacesServlet + + jakarta.faces.webapp.FacesServlet.FacesServlet +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2090 + + String + + jakarta.faces.webapp.FacesServlet.getServletInfo +
+
+
+ Return information about this Servlet. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:32 + + ApplicationFactory + + jakarta.faces.application.ApplicationFactory.ApplicationFactory +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:1712 + + FacesContextFactory + + jakarta.faces.context.FacesContextFactory.FacesContextFactory +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:1927 + + LifecycleFactory + + jakarta.faces.lifecycle.LifecycleFactory.LifecycleFactory +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:1991 + + RenderKitFactory + + jakarta.faces.render.RenderKitFactory.RenderKitFactory +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:6__OLD + + Object + + jakarta.faces.FactoryFinder.getFactory +
+ ( + String + ) +
+
+ Create (if necessary) and return a per-web-application instance of the appropriate + implementation class for the specified JavaServer Faces factory class, based on the discovery + algorithm described in the class description. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6 + + Object + + jakarta.faces.FactoryFinder.getFactory +
+ ( + String + ) +
+
+ Create (if necessary) and return a per-web-application instance of the appropriate + implementation class for the specified Jakarta Faces factory class, based on the discovery algorithm + described in the class description. The standard injectionProvider and wrappers in Jakarta Faces all + implement the interface FacesWrapper. If the returned Object is an implementation of one of the + standard injectionProvider, it must be legal to cast it to an instance of FacesWrapper and call + FacesWrapper#getWrapped on the instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:11__OLD + + void + + jakarta.faces.FactoryFinder.releaseFactories +
+
+
+ Release any references to factory instances associated with the class loader for the + calling web application. This method should be called as apart of web application shutdown in a + container where the JavaServer Faces API classes are part of the container itself, rather than being + included inside the web application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:11 + + void + + jakarta.faces.FactoryFinder.releaseFactories +
+
+
+ Release any references to factory instances associated with the class loader for the + calling web application. This method must be called during of web application shutdown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:16__OLD + + ActionListener + + jakarta.faces.application.Application.getActionListener +
+
+
+ Return the ActionListener that will be the default ActionListener to be registered with + relevant components during the Reconstitute Component Tree phase of the request processing + lifecycle. The default implementation will perform the following functions: The getPhaseId() method + of this listener instance must return PhaseId.INVOKE_APPLICATION. If the source component has a + non-null action property, return that value. If the source component has a non-null actionRef + property, evaluate this value reference to retrieve the corresponding object. If there is no such + corresponding object, or if this object does not implement Action, throw an + IllegalArgumentException. Call the invoke() method of the returned object, and return the return + value from that method call. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:16 + + ActionListener + + jakarta.faces.application.Application.getActionListener +
+
+
+ Return the default ActionListener to be registered for all + jakarta.faces.component.ActionSource components in this application. If not explicitly set, a + default implementation must be provided that performs the functions as specified in the section + 7.1.1 "ActionListener Property" in the chapter 7 "Application Integration" of the Jakarta Faces + Specification Document. Note that the specification for the default ActionListener contiues to call + for the use of a deprecated property (action) and class (MethodBinding). Unfortunately, this is + necessary because the default ActionListener must continue to work with components that do not + implement jakarta.faces.component.ActionSource2, and only implement + jakarta.faces.component.ActionSource. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:17__OLD + + NavigationHandler + + jakarta.faces.application.Application.getNavigationHandler +
+
+
+ Return the NavigationHandler instance that will be passed the outcome returned by any + invoked Action for this web application. The default implementation must provide the behavior + described in the NavigationHandler class description. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:17 + + NavigationHandler + + jakarta.faces.application.Application.getNavigationHandler +
+
+
+ Return the NavigationHandler instance that will be passed the outcome returned by any + invoked application action for this web application. If not explicitly set, a default implementation + must be provided that performs the functions described in the NavigationHandler class description. + The NavigationHandler implementation is declared in the application configuration resources by + giving the fully qualified class name as the value of the element within the element. The runtime + must employ the decorator pattern as for every other pluggable artifact in Jakarta Faces. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:23__OLD + + void + + jakarta.faces.application.Application.setActionListener +
+ ( + ActionListener + ) +
+
+ Replace the default ActionListener that will be registered with relevant components + during the Reconstitute Component Tree phase of the requset processing lifecycle. This listener must + return PhaseId.INVOKE_APPLICATION from its getPhaseId() method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:23 + + void + + jakarta.faces.application.Application.setActionListener +
+ ( + ActionListener + ) +
+
+ Set the default ActionListener to be registered for all + jakarta.faces.component.ActionSource components. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:26__OLD + + void + + jakarta.faces.application.Application.setNavigationHandler +
+ ( + NavigationHandler + ) +
+
+ Set the NavigationHandler instance that will be passed the outcome returned by any + invoked Action for this web application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:26 + + void + + jakarta.faces.application.Application.setNavigationHandler +
+ ( + NavigationHandler + ) +
+
+ Set the NavigationHandler instance that will be passed the outcome returned by any + invoked application action for this web application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:74__OLD + + void + + jakarta.faces.component.UICommand.addActionListener +
+ ( + ActionListener + ) +
+
+ Add a new ActionListener to the set of listeners interested in being notified when + ActionEvents occur. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:74 + + void + + jakarta.faces.component.UICommand.addActionListener +
+ ( + ActionListener + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:86__OLD + + void + + jakarta.faces.component.UICommand.removeActionListener +
+ ( + ActionListener + ) +
+
+ Remove an existing ActionListener (if any) from the set of listeners interested in + being notified when ActionEvents occur. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:86 + + void + + jakarta.faces.component.UICommand.removeActionListener +
+ ( + ActionListener + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:203__OLD + + void + + jakarta.faces.component.UIComponent.decode +
+ ( + FacesContext + ) +
+
+ Decode the current state of this UIComponent from the request contained in the + specified FacesContext, and attempt to convert this state information into an object of the required + type for this component (optionally using the registered jakarta.faces.convert.Converter for this + component, if there is one. If conversion is successful: Save the new local value of this component + by calling setValue() and passing the new value. Set the valid property of this component to true. + If conversion is not successful: Save state information in such a way that encoding can reproduce + the previous input (even though it was syntactically or semantically incorrect) Add an appropriate + conversion failure error message by calling context.addMessage(). Set the valid property of this + comonent to false. During decoding, events may be enqueued for later processing (by event listeners + who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:203 + + void + + jakarta.faces.component.UIComponent.decode +
+ ( + FacesContext + ) +
+
+ Decode any new state of this UIComponent from the request contained in the specified + FacesContext, and store this state as needed. During decoding, events may be enqueued for later + processing (by event listeners who have registered an interest), by calling queueEvent(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:206__OLD + + void + + jakarta.faces.component.UIComponent.encodeBegin +
+ ( + FacesContext + ) +
+
+ Render the beginning of the current state of this UIComponent to the response contained + in the specified FacesContext. If the conversion attempted in a previous call to decode() for this + component failed, the state information saved during execution of decode() should be utilized to + reproduce the incorrect input. If the conversion was successful, or if there was no previous call to + decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the + value as appropriate. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:206 + + void + + jakarta.faces.component.UIComponent.encodeBegin +
+ ( + FacesContext + ) +
+
+ If our rendered property is true, render the beginning of the current state of this + UIComponent to the response contained in the specified FacesContext. Call + #pushComponentToEL(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent). Call + jakarta.faces.application.Application#publishEvent, passing + jakarta.faces.event.PreRenderComponentEvent.class as the first argument and the component instance + to be rendered as the second argument. If a Renderer is associated with this UIComponent, the actual + encoding will be delegated to Renderer#encodeBegin(FacesContext, UIComponent). If our rendered + property is false, call + #pushComponentToEL(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent) and + return immediately. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:209__OLD + + void + + jakarta.faces.component.UIComponent.encodeChildren +
+ ( + FacesContext + ) +
+
+ Render the child UIComponents of this UIComponent, following the rules described for + encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if + the rendersChildren property is true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:209 + + void + + jakarta.faces.component.UIComponent.encodeChildren +
+ ( + FacesContext + ) +
+
+ If our rendered property is true, render the child UIComponents of this UIComponent. + This method will only be called if the rendersChildren property is true. If a Renderer is associated + with this UIComponent, the actual encoding will be delegated to + Renderer#encodeChildren(FacesContext, UIComponent). If no Renderer is associated with this + UIComponent, iterate over each of the children of this component and call + #encodeAll(jakarta.faces.context.FacesContext). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:212__OLD + + void + + jakarta.faces.component.UIComponent.encodeEnd +
+ ( + FacesContext + ) +
+
+ Render the ending of the current state of this UIComponent, following the rules + described for encodeBegin() to acquire the appropriate value to be rendered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:212 + + void + + jakarta.faces.component.UIComponent.encodeEnd +
+ ( + FacesContext + ) +
+
+ If our rendered property is true, render the ending of the current state of this + UIComponent. If a Renderer is associated with this UIComponent, the actual encoding will be + delegated to Renderer#encodeEnd(FacesContext, UIComponent). Call UIComponent#popComponentFromEL. + before returning regardless of the value of the rendered property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:215__OLD + + UIComponent + + jakarta.faces.component.UIComponent.findComponent +
+ ( + String + ) +
+
+ Find the UIComponent named by the specified expression, if any is found. This is done + by locating the closest parent UIComponent that is a NamingContainer, and calling its + findComponentInNamespace() method. The specified expr may contain either a component identifier, or + a set of component identifiers separated by SEPARATOR_CHAR characters. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:215 + + UIComponent + + jakarta.faces.component.UIComponent.findComponent +
+ ( + String + ) +
+
+ Search for and return the UIComponent with an id that matches the specified search + expression (if any), according to the algorithm described below. WARNING: The found UIComponent + instance, if any, is returned without regard for its tree traversal context. Retrieving an Jakarta + Expression Language-bound attribute from the component is not safe. Jakarta Expression Language + expressions can contain implicit objects, such as #{component}, which assume they are being + evaluated within the scope of a tree traversal context. Evaluating expressions with these kinds of + implicit objects outside of a tree traversal context produces undefined results. See + #invokeOnComponent for a method that does correctly account for the tree traversal context when + operating on the found UIComponent instance. #invokeOnComponent is also useful to find components + given a simple clientId. Component identifiers are required to be unique within the scope of the + closest ancestor NamingContainer that encloses this component (which might be this component + itself). If there are no NamingContainer components in the ancestry of this component, the root + component in the tree is treated as if it were a NamingContainer, whether or not its class actually + implements the NamingContainer interface. A search expression consists of either an identifier + (which is matched exactly against the id property of a UIComponent, or a series of such identifiers + linked by the UINamingContainer#getSeparatorChar character value. The search algorithm should + operates as follows, though alternate alogrithms may be used as long as the end result is the same: + Identify the UIComponent that will be the base for searching, by stopping as soon as one of the + following conditions is met: If the search expression begins with the the separator character + (called an "absolute" search expression), the base will be the root UIComponent of the component + tree. The leading separator character will be stripped off, and the remainder of the search + expression will be treated as a "relative" search expression as described below. Otherwise, if this + UIComponent is a NamingContainer it will serve as the basis. Otherwise, search up the parents of + this component. If a NamingContainer is encountered, it will be the base. Otherwise (if no + NamingContainer is encountered) the root UIComponent will be the base. The search expression + (possibly modified in the previous step) is now a "relative" search expression that will be used to + locate the component (if any) that has an id that matches, within the scope of the base component. + The match is performed as follows: If the search expression is a simple identifier, this value is + compared to the id property, and then recursively through the facets and children of the base + UIComponent (except that if a descendant NamingContainer is found, its own facets and children are + not searched). If the search expression includes more than one identifier separated by the separator + character, the first identifier is used to locate a NamingContainer by the rules in the previous + bullet point. Then, the findComponent() method of this NamingContainer will be called, passing the + remainder of the search expression. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:222__OLD + + int + + jakarta.faces.component.UIComponent.getChildCount +
+
+
+ Return the number of UIComponents on the child list for this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:222 + + int + + jakarta.faces.component.UIComponent.getChildCount +
+
+
+ Return the number of child UIComponents that are associated with this UIComponent. If + there are no children, this method must return 0. The method must not cause the creation of a child + component list. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:224__OLD + + String + + jakarta.faces.component.UIComponent.getClientId +
+ ( + FacesContext + ) +
+
+ Return a client-side identifier for this component, generating one if necessary. + Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:224 + + String + + jakarta.faces.component.UIComponent.getClientId +
+ ( + FacesContext + ) +
+
+ Return a client-side identifier for this component, generating one if necessary. The + associated Renderer, if any, will be asked to convert the clientId to a form suitable for + transmission to the client. The return from this method must be the same value throughout the + lifetime of the instance, unless the id property of the component is changed, or the component is + placed in a NamingContainer whose client ID changes (for example, UIData). However, even in these + cases, consecutive calls to this method must always return the same value. The implementation must + follow these steps in determining the clientId: Find the closest ancestor to this component in the + view hierarchy that implements NamingContainer. Call getContainerClientId() on it and save the + result as the parentId local variable. Call #getId on this component and save the result as the myId + local variable. If myId is null, call context.getViewRoot().createUniqueId() and assign the result + to myId. If parentId is non-null, let myId equal parentId + UINamingContainer#getSeparatorChar + + myId. Call Renderer#convertClientId, passing myId, and return the result. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:229__OLD + + UIComponent + + jakarta.faces.component.UIComponent.getFacet +
+ ( + String + ) +
+
+ Return the facet UIComponent associated with the specified name, if any. Otherwise, + return null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:229 + + UIComponent + + jakarta.faces.component.UIComponent.getFacet +
+ ( + String + ) +
+
+ Convenience method to return the named facet, if it exists, or null otherwise. If the + requested facet does not exist, the facets Map must not be created. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:232__OLD + + Iterator + + jakarta.faces.component.UIComponent.getFacetsAndChildren +
+
+
+ Return an Iterator over the facet followed by child UIComponents of this UIComponent. + Facets are returned in an undefined order, followed by all the children in the order they are stored + in the child list. If this component has no facets or children, an empty Iterator is returned. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:232 + + Iterator + + jakarta.faces.component.UIComponent.getFacetsAndChildren +
+
+
+ Return an Iterator over the facet followed by child UIComponents of this UIComponent. + Facets are returned in an undefined order, followed by all the children in the order they are stored + in the child list. If this component has no facets or children, an empty Iterator is returned. The + returned Iterator must not support the remove() operation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:233__OLD + + UIComponent + + jakarta.faces.component.UIComponent.getParent +
+
+
+ Return the parent UIComponent of this UIComponent, if any. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:233 + + UIComponent + + jakarta.faces.component.UIComponent.getParent +
+
+
+ Return the parent UIComponent of this UIComponent, if any. A component must allow child + components to be added to and removed from the list of children of this component, even though the + child component returns null from getParent( ). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:235__OLD + + boolean + + jakarta.faces.component.UIComponent.getRendersChildren +
+
+
+ Return a flag indicating whether this component is responsible for rendering its child + components. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:235 + + boolean + + jakarta.faces.component.UIComponent.getRendersChildren +
+
+
+ Return a flag indicating whether this component is responsible for rendering its child + components. The default implementation in UIComponentBase#getRendersChildren tries to find the + renderer for this component. If it does, it calls Renderer#getRendersChildren and returns the + result. If it doesn't, it returns false. As of version 1.2 of the Jakarta Faces Specification, + component authors are encouraged to return true from this method and rely on + UIComponentBase#encodeChildren. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:240__OLD + + void + + jakarta.faces.component.UIComponent.processDecodes +
+ ( + FacesContext + ) +
+
+ Perform the component tree processing required by the Apply Request Values phase of the + request processing lifecycle for all facets of this component, all children of this component, and + this component itself, as follows. Call the processDecodes() method of all facets and children of + this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() + method of this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:240 + + void + + jakarta.faces.component.UIComponent.processDecodes +
+ ( + FacesContext + ) +
+
+ Perform the component tree processing required by the Apply Request Values phase of the + request processing lifecycle for all facets of this component, all children of this component, and + this component itself, as follows. If the rendered property of this UIComponent is false, skip + further processing. Call #pushComponentToEL. Call the processDecodes() method of all facets and + children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the + decode() method of this component. Call #popComponentFromEL from inside of a finally block, just + before returning. If a RuntimeException is thrown during decode processing, call + FacesContext#renderResponse and re-throw the exception. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:246__OLD + + void + + jakarta.faces.component.UIComponent.processUpdates +
+ ( + FacesContext + ) +
+
+ Perform the component tree processing required by the Update Model Values phase of the + request processing lifecycle for all facets of this component, all children of this component, and + this component itself, as follows. Call the processUpdates() method of all facets and children of + this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the + updateModel() method of this component. If the valid property of this UIComponent is now false, call + FacesContext.renderResponse() to transfer control at the end of the current phase. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:246 + + void + + jakarta.faces.component.UIComponent.processUpdates +
+ ( + FacesContext + ) +
+
+ Perform the component tree processing required by the Update Model Values phase of the + request processing lifecycle for all facets of this component, all children of this component, and + this component itself, as follows. If the rendered property of this UIComponent is false, skip + further processing. Call #pushComponentToEL. Call the processUpdates() method of all facets and + children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). After + returning from the processUpdates() method on a child or facet, call UIComponent#popComponentFromEL + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:248__OLD + + void + + jakarta.faces.component.UIComponent.processValidators +
+ ( + FacesContext + ) +
+
+ Perform the component tree processing required by the Process Validations phase of the + request processing lifecycle for all facets of this component, all children of this component, and + this component itself, as follows. Call the processValidators() method of all facets and children of + this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property + of this component is currently true: Call the validate() method of each Validator registered for + this UIComponent. Call the validate() method of this component. Set the valid property of this + component to the result returned from the validate() method. If the valid property of this + UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the + current phase. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:248 + + void + + jakarta.faces.component.UIComponent.processValidators +
+ ( + FacesContext + ) +
+
+ Perform the component tree processing required by the Process Validations phase of the + request processing lifecycle for all facets of this component, all children of this component, and + this component itself, as follows. If the rendered property of this UIComponent is false, skip + further processing. Call #pushComponentToEL. Call the processValidators() method of all facets and + children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). After + returning from calling getFacetsAndChildren() call UIComponent#popComponentFromEL. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:269__OLD + + void + + jakarta.faces.component.UIComponent.setParent +
+ ( + UIComponent + ) +
+
+ Set the parent UIComponent of this UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:269 + + void + + jakarta.faces.component.UIComponent.setParent +
+ ( + UIComponent + ) +
+
+ Set the parent UIComponent of this UIComponent. If parent.isInView() returns true, + calling this method will first cause a jakarta.faces.event.PreRemoveFromViewEvent to be published, + for this node, and then the children of this node. Then, once the re-parenting has occurred, a + jakarta.faces.event.PostAddToViewEvent will be published as well, first for this node, and then for + the node's children, but only if any of the following conditions are true. + jakarta.faces.context.FacesContext#getCurrentPhaseId returns + jakarta.faces.event.PhaseId#RESTORE_VIEW and partial state saving is enabled. + jakarta.faces.context.FacesContext#isPostback returns false and + jakarta.faces.context.FacesContext#getCurrentPhaseId returns something other than + jakarta.faces.event.PhaseId#RESTORE_VIEW This method must never be called by developers; a + UIComponent's internal implementation will call it as components are added to or removed from a + parent's child List or facet Map. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:298__OLD + + void + + jakarta.faces.component.UIComponentBase.decode +
+ ( + FacesContext + ) +
+
+ Decode the current state of this UIComponent from the request contained in the + specified FacesContext, and attempt to convert this state information into an object of the required + type for this component (optionally using the registered jakarta.faces.convert.Converter for this + component, if there is one. If conversion is successful: Save the new local value of this component + by calling setValue() and passing the new value. Set the valid property of this component to true. + If conversion is not successful: Save state information in such a way that encoding can reproduce + the previous input (even though it was syntactically or semantically incorrect) Add an appropriate + conversion failure error message by calling context.addMessage(). Set the valid property of this + comonent to false. During decoding, events may be enqueued for later processing (by event listeners + who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:298 + + void + + jakarta.faces.component.UIComponentBase.decode +
+ ( + FacesContext + ) +
+
+ Decode any new state of this UIComponent from the request contained in the specified + FacesContext, and store this state as needed. During decoding, events may be enqueued for later + processing (by event listeners who have registered an interest), by calling queueEvent(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:301__OLD + + void + + jakarta.faces.component.UIComponentBase.encodeBegin +
+ ( + FacesContext + ) +
+
+ Render the beginning of the current state of this UIComponent to the response contained + in the specified FacesContext. If the conversion attempted in a previous call to decode() for this + component failed, the state information saved during execution of decode() should be utilized to + reproduce the incorrect input. If the conversion was successful, or if there was no previous call to + decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the + value as appropriate. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:301 + + void + + jakarta.faces.component.UIComponentBase.encodeBegin +
+ ( + FacesContext + ) +
+
+ If our rendered property is true, render the beginning of the current state of this + UIComponent to the response contained in the specified FacesContext. Call + #pushComponentToEL(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent). Call + jakarta.faces.application.Application#publishEvent, passing + jakarta.faces.event.PreRenderComponentEvent.class as the first argument and the component instance + to be rendered as the second argument. If a Renderer is associated with this UIComponent, the actual + encoding will be delegated to Renderer#encodeBegin(FacesContext, UIComponent). If our rendered + property is false, call + #pushComponentToEL(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent) and + return immediately. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:304__OLD + + void + + jakarta.faces.component.UIComponentBase.encodeChildren +
+ ( + FacesContext + ) +
+
+ Render the child UIComponents of this UIComponent, following the rules described for + encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if + the rendersChildren property is true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:304 + + void + + jakarta.faces.component.UIComponentBase.encodeChildren +
+ ( + FacesContext + ) +
+
+ If our rendered property is true, render the child UIComponents of this UIComponent. + This method will only be called if the rendersChildren property is true. If a Renderer is associated + with this UIComponent, the actual encoding will be delegated to + Renderer#encodeChildren(FacesContext, UIComponent). If no Renderer is associated with this + UIComponent, iterate over each of the children of this component and call + #encodeAll(jakarta.faces.context.FacesContext). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:307__OLD + + void + + jakarta.faces.component.UIComponentBase.encodeEnd +
+ ( + FacesContext + ) +
+
+ Render the ending of the current state of this UIComponent, following the rules + described for encodeBegin() to acquire the appropriate value to be rendered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:307 + + void + + jakarta.faces.component.UIComponentBase.encodeEnd +
+ ( + FacesContext + ) +
+
+ If our rendered property is true, render the ending of the current state of this + UIComponent. If a Renderer is associated with this UIComponent, the actual encoding will be + delegated to Renderer#encodeEnd(FacesContext, UIComponent). Call UIComponent#popComponentFromEL. + before returning regardless of the value of the rendered property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:310__OLD + + UIComponent + + jakarta.faces.component.UIComponentBase.findComponent +
+ ( + String + ) +
+
+ Find the UIComponent named by the specified expression, if any is found. This is done + by locating the closest parent UIComponent that is a NamingContainer, and calling its + findComponentInNamespace() method. The specified expr may contain either a component identifier, or + a set of component identifiers separated by SEPARATOR_CHAR characters. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:310 + + UIComponent + + jakarta.faces.component.UIComponentBase.findComponent +
+ ( + String + ) +
+
+ Search for and return the UIComponent with an id that matches the specified search + expression (if any), according to the algorithm described below. WARNING: The found UIComponent + instance, if any, is returned without regard for its tree traversal context. Retrieving an Jakarta + Expression Language-bound attribute from the component is not safe. Jakarta Expression Language + expressions can contain implicit objects, such as #{component}, which assume they are being + evaluated within the scope of a tree traversal context. Evaluating expressions with these kinds of + implicit objects outside of a tree traversal context produces undefined results. See + #invokeOnComponent for a method that does correctly account for the tree traversal context when + operating on the found UIComponent instance. #invokeOnComponent is also useful to find components + given a simple clientId. Component identifiers are required to be unique within the scope of the + closest ancestor NamingContainer that encloses this component (which might be this component + itself). If there are no NamingContainer components in the ancestry of this component, the root + component in the tree is treated as if it were a NamingContainer, whether or not its class actually + implements the NamingContainer interface. A search expression consists of either an identifier + (which is matched exactly against the id property of a UIComponent, or a series of such identifiers + linked by the UINamingContainer#getSeparatorChar character value. The search algorithm should + operates as follows, though alternate alogrithms may be used as long as the end result is the same: + Identify the UIComponent that will be the base for searching, by stopping as soon as one of the + following conditions is met: If the search expression begins with the the separator character + (called an "absolute" search expression), the base will be the root UIComponent of the component + tree. The leading separator character will be stripped off, and the remainder of the search + expression will be treated as a "relative" search expression as described below. Otherwise, if this + UIComponent is a NamingContainer it will serve as the basis. Otherwise, search up the parents of + this component. If a NamingContainer is encountered, it will be the base. Otherwise (if no + NamingContainer is encountered) the root UIComponent will be the base. The search expression + (possibly modified in the previous step) is now a "relative" search expression that will be used to + locate the component (if any) that has an id that matches, within the scope of the base component. + The match is performed as follows: If the search expression is a simple identifier, this value is + compared to the id property, and then recursively through the facets and children of the base + UIComponent (except that if a descendant NamingContainer is found, its own facets and children are + not searched). If the search expression includes more than one identifier separated by the separator + character, the first identifier is used to locate a NamingContainer by the rules in the previous + bullet point. Then, the findComponent() method of this NamingContainer will be called, passing the + remainder of the search expression. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:317__OLD + + int + + jakarta.faces.component.UIComponentBase.getChildCount +
+
+
+ Return the number of UIComponents on the child list for this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:317 + + int + + jakarta.faces.component.UIComponentBase.getChildCount +
+
+
+ Return the number of child UIComponents that are associated with this UIComponent. If + there are no children, this method must return 0. The method must not cause the creation of a child + component list. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:319__OLD + + String + + jakarta.faces.component.UIComponentBase.getClientId +
+ ( + FacesContext + ) +
+
+ Return a client-side identifier for this component, generating one if necessary. + Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:319 + + String + + jakarta.faces.component.UIComponentBase.getClientId +
+ ( + FacesContext + ) +
+
+ Return a client-side identifier for this component, generating one if necessary. The + associated Renderer, if any, will be asked to convert the clientId to a form suitable for + transmission to the client. The return from this method must be the same value throughout the + lifetime of the instance, unless the id property of the component is changed, or the component is + placed in a NamingContainer whose client ID changes (for example, UIData). However, even in these + cases, consecutive calls to this method must always return the same value. The implementation must + follow these steps in determining the clientId: Find the closest ancestor to this component in the + view hierarchy that implements NamingContainer. Call getContainerClientId() on it and save the + result as the parentId local variable. Call #getId on this component and save the result as the myId + local variable. If myId is null, call context.getViewRoot().createUniqueId() and assign the result + to myId. If parentId is non-null, let myId equal parentId + UINamingContainer#getSeparatorChar + + myId. Call Renderer#convertClientId, passing myId, and return the result. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:324__OLD + + UIComponent + + jakarta.faces.component.UIComponentBase.getFacet +
+ ( + String + ) +
+
+ Return the facet UIComponent associated with the specified name, if any. Otherwise, + return null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:324 + + UIComponent + + jakarta.faces.component.UIComponentBase.getFacet +
+ ( + String + ) +
+
+ Convenience method to return the named facet, if it exists, or null otherwise. If the + requested facet does not exist, the facets Map must not be created. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:327__OLD + + Iterator + + jakarta.faces.component.UIComponentBase.getFacetsAndChildren +
+
+
+ Return an Iterator over the facet followed by child UIComponents of this UIComponent. + Facets are returned in an undefined order, followed by all the children in the order they are stored + in the child list. If this component has no facets or children, an empty Iterator is returned. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:327 + + Iterator + + jakarta.faces.component.UIComponentBase.getFacetsAndChildren +
+
+
+ Return an Iterator over the facet followed by child UIComponents of this UIComponent. + Facets are returned in an undefined order, followed by all the children in the order they are stored + in the child list. If this component has no facets or children, an empty Iterator is returned. The + returned Iterator must not support the remove() operation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:328__OLD + + UIComponent + + jakarta.faces.component.UIComponentBase.getParent +
+
+
+ Return the parent UIComponent of this UIComponent, if any. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:328 + + UIComponent + + jakarta.faces.component.UIComponentBase.getParent +
+
+
+ Return the parent UIComponent of this UIComponent, if any. A component must allow child + components to be added to and removed from the list of children of this component, even though the + child component returns null from getParent( ). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:330__OLD + + boolean + + jakarta.faces.component.UIComponentBase.getRendersChildren +
+
+
+ Return a flag indicating whether this component is responsible for rendering its child + components. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:330 + + boolean + + jakarta.faces.component.UIComponentBase.getRendersChildren +
+
+
+ Return a flag indicating whether this component is responsible for rendering its child + components. The default implementation in UIComponentBase#getRendersChildren tries to find the + renderer for this component. If it does, it calls Renderer#getRendersChildren and returns the + result. If it doesn't, it returns false. As of version 1.2 of the Jakarta Faces Specification, + component authors are encouraged to return true from this method and rely on + UIComponentBase#encodeChildren. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:335__OLD + + void + + jakarta.faces.component.UIComponentBase.processDecodes +
+ ( + FacesContext + ) +
+
+ Perform the component tree processing required by the Apply Request Values phase of the + request processing lifecycle for all facets of this component, all children of this component, and + this component itself, as follows. Call the processDecodes() method of all facets and children of + this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() + method of this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:335 + + void + + jakarta.faces.component.UIComponentBase.processDecodes +
+ ( + FacesContext + ) +
+
+ Perform the component tree processing required by the Apply Request Values phase of the + request processing lifecycle for all facets of this component, all children of this component, and + this component itself, as follows. If the rendered property of this UIComponent is false, skip + further processing. Call #pushComponentToEL. Call the processDecodes() method of all facets and + children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the + decode() method of this component. Call #popComponentFromEL from inside of a finally block, just + before returning. If a RuntimeException is thrown during decode processing, call + FacesContext#renderResponse and re-throw the exception. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:341__OLD + + void + + jakarta.faces.component.UIComponentBase.processUpdates +
+ ( + FacesContext + ) +
+
+ Perform the component tree processing required by the Update Model Values phase of the + request processing lifecycle for all facets of this component, all children of this component, and + this component itself, as follows. Call the processUpdates() method of all facets and children of + this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the + updateModel() method of this component. If the valid property of this UIComponent is now false, call + FacesContext.renderResponse() to transfer control at the end of the current phase. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:341 + + void + + jakarta.faces.component.UIComponentBase.processUpdates +
+ ( + FacesContext + ) +
+
+ Perform the component tree processing required by the Update Model Values phase of the + request processing lifecycle for all facets of this component, all children of this component, and + this component itself, as follows. If the rendered property of this UIComponent is false, skip + further processing. Call #pushComponentToEL. Call the processUpdates() method of all facets and + children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). After + returning from the processUpdates() method on a child or facet, call UIComponent#popComponentFromEL + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:343__OLD + + void + + jakarta.faces.component.UIComponentBase.processValidators +
+ ( + FacesContext + ) +
+
+ Perform the component tree processing required by the Process Validations phase of the + request processing lifecycle for all facets of this component, all children of this component, and + this component itself, as follows. Call the processValidators() method of all facets and children of + this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property + of this component is currently true: Call the validate() method of each Validator registered for + this UIComponent. Call the validate() method of this component. Set the valid property of this + component to the result returned from the validate() method. If the valid property of this + UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the + current phase. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:343 + + void + + jakarta.faces.component.UIComponentBase.processValidators +
+ ( + FacesContext + ) +
+
+ Perform the component tree processing required by the Process Validations phase of the + request processing lifecycle for all facets of this component, all children of this component, and + this component itself, as follows. If the rendered property of this UIComponent is false, skip + further processing. Call #pushComponentToEL. Call the processValidators() method of all facets and + children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). After + returning from calling getFacetsAndChildren() call UIComponent#popComponentFromEL. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:364__OLD + + void + + jakarta.faces.component.UIComponentBase.setParent +
+ ( + UIComponent + ) +
+
+ Set the parent UIComponent of this UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:364 + + void + + jakarta.faces.component.UIComponentBase.setParent +
+ ( + UIComponent + ) +
+
+ Set the parent UIComponent of this UIComponent. If parent.isInView() returns true, + calling this method will first cause a jakarta.faces.event.PreRemoveFromViewEvent to be published, + for this node, and then the children of this node. Then, once the re-parenting has occurred, a + jakarta.faces.event.PostAddToViewEvent will be published as well, first for this node, and then for + the node's children, but only if any of the following conditions are true. + jakarta.faces.context.FacesContext#getCurrentPhaseId returns + jakarta.faces.event.PhaseId#RESTORE_VIEW and partial state saving is enabled. + jakarta.faces.context.FacesContext#isPostback returns false and + jakarta.faces.context.FacesContext#getCurrentPhaseId returns something other than + jakarta.faces.event.PhaseId#RESTORE_VIEW This method must never be called by developers; a + UIComponent's internal implementation will call it as components are added to or removed from a + parent's child List or facet Map. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:368__OLD + + UIComponentBase + + jakarta.faces.component.UIComponentBase.UIComponentBase +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:368 + + UIComponentBase + + jakarta.faces.component.UIComponentBase.UIComponentBase +
+
+
+ Default constructor, populates the descriptor map. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:590__OLD + + void + + jakarta.faces.component.UIInput.updateModel +
+ ( + FacesContext + ) +
+
+ Perform the following algorithm to update the model data associated with this UIInput, + if any, as appropriate. If the valid property of this component is false, take no further action. If + the valueRef property of this component is null, take no further action. Retrieve the Application + instance for this web application from ApplicationFactory. Ask it for a ValueBinding for the + valueRef expression. Use the setValue() method of the ValueBinding to update the value that the + value reference expression points at. If the setValue() method returns successfully: Clear the local + value of this UIInput. Set the valid property of this UIInput to true. If the setValue() method call + fails: Enqueue error messages by calling addMessage() on the specified FacesContext instance. Set + the valid property of this UIInput to false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:590 + + void + + jakarta.faces.component.UIInput.updateModel +
+ ( + FacesContext + ) +
+
+ Perform the following algorithm to update the model data associated with this UIInput, + if any, as appropriate. If the valid property of this component is false, take no further action. If + the localValueSet property of this component is false, take no further action. If no ValueExpression + for value exists, take no further action. Call setValue() method of the ValueExpression to update + the value that the ValueExpression points at. If the setValue() method returns successfully: Clear + the local value of this UIInput. Set the localValueSet property of this UIInput to false. If the + setValue() method throws an Exception: Enqueue an error message. Create a FacesMessage with the id + #UPDATE_MESSAGE_ID. Create a UpdateModelException, passing the FacesMessage and the caught exception + to the constructor. Create an ExceptionQueuedEventContext, passing the FacesContext, the + UpdateModelException, this component instance, and PhaseId#UPDATE_MODEL_VALUES to its constructor. + Call FacesContext#getExceptionHandler and then call ExceptionHandler#processEvent, passing the + ExceptionQueuedEventContext. Set the valid property of this UIInput to false. The exception must not + be re-thrown. This enables tree traversal to continue for this lifecycle phase, as in all the other + lifecycle phases. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:593__OLD + + void + + jakarta.faces.component.UIInput.validate +
+ ( + FacesContext + ) +
+
+ Perform validations and, if validation is successful, and the local value is different + from the previous value, queue a ValueChangedEvent to be processed later. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:593 + + void + + jakarta.faces.component.UIInput.validate +
+ ( + FacesContext + ) +
+
+ Perform the following algorithm to validate the local value of this UIInput. Retrieve + the submitted value with #getSubmittedValue. If this returns null, and the value of the + #ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE context-param is true (ignoring case), examine the + value of the "required" property. If the value of "required" is true, continue as below. If the + value of "required" is false or the required attribute is not set, exit without further processing. + If the context-param is not set, or is set to false (ignoring case), exit without further + processing. (This indicates that no value was submitted for this component.) If the + jakarta.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL context parameter value is true + (ignoring case), and getSubmittedValue() returns a zero-length String call #setSubmittedValue, + passing null as the argument and continue processing using null as the current submitted value. + Convert the submitted value into a "local value" of the appropriate data type by calling + #getConvertedValue. If conversion fails: Enqueue an appropriate error message by calling the + addMessage() method on the FacesContext. Set the valid property on this component to false Validate + the property by calling #validateValue. If the valid property of this component is still true, + retrieve the previous value of the component (with getValue()), store the new local value using + setValue(), and reset the submitted value to null with a call to #setSubmittedValue passing null as + the argument. If the local value is different from the previous value of this component, as + determined by a call to #compareValues, fire a ValueChangeEvent to be broadcast to all interested + listeners. Application components implementing UIInput that wish to perform validation with logic + embedded in the component should perform their own correctness checks, and then call the + super.validate() method to perform the standard processing described above. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:700__OLD + + UINamingContainer + + jakarta.faces.component.UINamingContainer.UINamingContainer +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:700 + + UINamingContainer + + jakarta.faces.component.UINamingContainer.UINamingContainer +
+
+
+ Create a new UINamingContainer instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:799__OLD + + Object + + jakarta.faces.component.UIOutput.getValue +
+
+
+ Return the local value of this UIInput component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:799 + + Object + + jakarta.faces.component.UIOutput.getValue +
+
+
+ Return the value property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:801__OLD + + void + + jakarta.faces.component.UIOutput.setValue +
+ ( + Object + ) +
+
+ Set the local value of this UIInput component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:801 + + void + + jakarta.faces.component.UIOutput.setValue +
+ ( + Object + ) +
+
+ Set the value of this UIComponent (if any). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1109__OLD + + boolean + + jakarta.faces.component.UISelectBoolean.isSelected +
+
+
+ Return the local value of the selected state of this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1109 + + boolean + + jakarta.faces.component.UISelectBoolean.isSelected +
+
+
+ Return the local value of the selected state of this component. This method is a + typesafe alias for getValue(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1110__OLD + + void + + jakarta.faces.component.UISelectBoolean.setSelected +
+ ( + boolean + ) +
+
+ Set the local value of the selected state of this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1110 + + void + + jakarta.faces.component.UISelectBoolean.setSelected +
+ ( + boolean + ) +
+
+ Set the local value of the selected state of this component. This method is a typesafe + alias for setValue(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1229__OLD + + UISelectItem + + jakarta.faces.component.UISelectItem.UISelectItem +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:1229 + + UISelectItem + + jakarta.faces.component.UISelectItem.UISelectItem +
+
+
+ Create a new UISelectItem instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1333__OLD + + UISelectItems + + jakarta.faces.component.UISelectItems.UISelectItems +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:1333 + + UISelectItems + + jakarta.faces.component.UISelectItems.UISelectItems +
+
+
+ Create a new UISelectItems instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1436__OLD + + Object[] + + jakarta.faces.component.UISelectMany.getSelectedValues +
+
+
+ Return the currently selected items, or null if there are no currently selected items. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1436 + + Object[] + + jakarta.faces.component.UISelectMany.getSelectedValues +
+
+
+ Return the currently selected values, or null if there are no currently selected + values. This is a typesafe alias for getValue(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1437__OLD + + void + + jakarta.faces.component.UISelectMany.setSelectedValues +
+ ( + Object[] + ) +
+
+ Set the currently selected items, or null to indicate that there are no currently + selected items. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1437 + + void + + jakarta.faces.component.UISelectMany.setSelectedValues +
+ ( + Object[] + ) +
+
+ Set the currently selected values, or null to indicate that there are no currently + selected values. This is a typesafe alias for setValue(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1687__OLD + + FacesContext + + jakarta.faces.context.FacesContext.FacesContext +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:1687 + + FacesContext + + jakarta.faces.context.FacesContext.FacesContext +
+
+
+ Default constructor. This looks at the callstack to see if we're created from a + factory. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1688__OLD + + FacesContext + + jakarta.faces.context.FacesContext.getCurrentInstance +
+
+
+ Return the FacesContext instance for the request that is being processed by the current + thread. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1688 + + FacesContext + + jakarta.faces.context.FacesContext.getCurrentInstance +
+
+
+ Return the FacesContext instance for the request that is being processed by the current + thread. If called during application initialization or shutdown, any method documented as "valid to + call this method during application startup or shutdown" must be supported during application + startup or shutdown time. The result of calling a method during application startup or shutdown time + that does not have this designation is undefined. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1693__OLD + + Iterator + + jakarta.faces.context.FacesContext.getMessages +
+
+
+ Return an Iterator over the Messages that have been queued, whether or not they are + associated with any specific UIComponent. If no such messages have been queued, return an empty + Iterator. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1693 + + Iterator + + jakarta.faces.context.FacesContext.getMessages +
+
+
+ Return an Iterator over the jakarta.faces.application.FacesMessages that have been + queued, whether or not they are associated with any specific client identifier. If no such messages + have been queued, return an empty Iterator. The elements of the Iterator must be returned in the + order in which they were added with calls to #addMessage. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1701__OLD + + void + + jakarta.faces.context.FacesContext.release +
+
+
+ Release any resources associated with this FacesContext instance. Faces implementations + may choose to pool instances in the associated FacesContextFactory to avoid repeated object creation + and garbage collection. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1701 + + void + + jakarta.faces.context.FacesContext.release +
+
+
+ Release any resources associated with this FacesContext instance. Faces implementations + may choose to pool instances in the associated FacesContextFactory to avoid repeated object creation + and garbage collection. After release() is called on a FacesContext instance (until the FacesContext + instance has been recycled by the implementation for re-use), calling any other methods will cause + an IllegalStateException to be thrown. If a call was made to #getAttributes during the processing + for this request, the implementation must call clear() on the Map returned from getAttributes(), and + then de-allocate the data-structure behind that Map. The implementation must call + #setCurrentInstance passing null to remove the association between this thread and this dead + FacesContext instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1702__OLD + + void + + jakarta.faces.context.FacesContext.renderResponse +
+
+
+ Signal the JavaSerer faces implementation that, as soon as the current phase of the + request processing lifecycle has been completed, control should be passed to the Render Response + phase, bypassing any phases that have not been executed yet. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1702 + + void + + jakarta.faces.context.FacesContext.renderResponse +
+
+
+ Signal the Jakarta Faces implementation that, as soon as the current phase of the + request processing lifecycle has been completed, control should be passed to the Render Response + phase, bypassing any phases that have not been executed yet. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1703__OLD + + void + + jakarta.faces.context.FacesContext.responseComplete +
+
+
+ Signal the JavaServer Faces implementation that the HTTP response for this request has + already been generated (such as an HTTP redirect), and that the request processing lifecycle should + be terminated as soon as the current phase is completed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1703 + + void + + jakarta.faces.context.FacesContext.responseComplete +
+
+
+ Signal the Jakarta Faces implementation that the HTTP response for this request has + already been generated (such as an HTTP redirect), and that the request processing lifecycle should + be terminated as soon as the current phase is completed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1762__OLD + + void + + jakarta.faces.context.ResponseWriter.endElement +
+ ( + String + ) +
+
+ Write the end of an element, after closing any open element created by a call to + startElement(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1762 + + void + + jakarta.faces.context.ResponseWriter.endElement +
+ ( + String + ) +
+
+ Write the end of an element, after closing any open element created by a call to + startElement(). Elements must be closed in the inverse order from which they were opened; it is an + error to do otherwise. If the argument component's pass through attributes includes an attribute of + the name given by the value of the symbolic constant + jakarta.faces.render.Renderer#PASSTHROUGH_RENDERER_LOCALNAME_KEY, use that as the element name, + instead of the value passed as the first parameter to this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1775__OLD + + void + + jakarta.faces.context.ResponseWriter.writeComment +
+ ( + Object + ) +
+
+ Write a comment containing the specified text, after converting that text to a String + if necessary. If there is an open element that has been created by a call to startElement(), that + element will be closed first. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1775 + + void + + jakarta.faces.context.ResponseWriter.writeComment +
+ ( + Object + ) +
+
+ Write a comment containing the specified text, after converting that text to a String + (if necessary), and after performing any escaping appropriate for the markup language being + rendered. If there is an open element that has been created by a call to startElement(), that + element will be closed first. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1786__OLD + + void + + jakarta.faces.context.ResponseWriter.writeText +
+ ( + char[] + , +
+ int + , +
+ int + ) +
+
+ Write text from a character array, after escaping it properly for this method. If there + is an open element that has been created by a call to startElement(), that element will be closed + first. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1786 + + void + + jakarta.faces.context.ResponseWriter.writeText +
+ ( + char[] + , +
+ int + , +
+ int + ) +
+
+ Write text from a character array, after any performing any escaping appropriate for + the markup language being rendered. If there is an open element that has been created by a call to + startElement(), that element will be closed first. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1808__OLD + + Object + + jakarta.faces.convert.Converter.getAsObject +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Convert the specified string value, which is associated with the specified UIComponent, + into a model data object that is appropriate for being stored during the Apply Request Values phase + of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1808 + + Object + + jakarta.faces.convert.Converter.getAsObject +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Convert the specified string value, which is associated with the specified UIComponent, + into a model data object that is appropriate for being stored during the Process Validations phase + of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1891__OLD + + AbortProcessingException + + jakarta.faces.event.AbortProcessingException.AbortProcessingException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:1891 + + AbortProcessingException + + jakarta.faces.event.AbortProcessingException.AbortProcessingException +
+
+
+ Construct a new exception with no detail message or root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1897__OLD + + void + + jakarta.faces.event.ActionListener.processAction +
+ ( + ActionEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ Signal the JavaServer Faces implementation that no further processing on the current + event should be performed + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1897 + + void + + jakarta.faces.event.ActionListener.processAction +
+ ( + ActionEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ Signal the Jakarta Faces implementation that no further processing on the current event + should be performed + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1912__OLD + + void + + jakarta.faces.lifecycle.Lifecycle.execute +
+ ( + FacesContext + ) +
+
+ Execute all of the phases of the request processing lifecycle, as described in the + JavaServer Faces Specification, in the specified order. The processing flow can be affected (by the + application, by components, or by event listeners) by calls to the renderResponse() or + responseComplete() methods of the FacesContext instance associated with the current request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1912 + + void + + jakarta.faces.lifecycle.Lifecycle.execute +
+ ( + FacesContext + ) +
+
+ Execute all of the phases of the request processing lifecycle, up to but not including + the Render Response phase, as described in section 2 "Request Processing Lifecycle" of the Jakarta + Faces Specification Document, in the specified order. The processing flow can be affected (by the + application, by components, or by event listeners) by calls to the renderResponse() or + responseComplete() methods of the FacesContext instance associated with the current request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1932__OLD + + void + + jakarta.faces.render.Renderer.decode +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Decode the current state of the specified UIComponent from the request contained in the + specified FacesContext, and attempt to convert this state information into an object of the type + required for this component (optionally using the registered jakarta.faces.convert.Converter for + this component, if there is one). If conversion is successful: Save the new local value of this + component by calling setValue() and passing the new value. Set the value property of this component + to true. If conversion is not successful: Save the state information (inside the component) in such + a way that encoding can reproduce the previous input (even though it was syntactically or + semantically incorrect). Add an appropriate conversion failure error message by calling addMessage() + on the specified FacesContext. Set the valid property of this component to false. During decoding, + events may be enqueued for later processing (by event listeners that have registered an interest), + by calling addFacesEvent() on the associated FacesContext. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1932 + + void + + jakarta.faces.render.Renderer.decode +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Decode any new state of the specified UIComponent from the request contained in the + specified FacesContext, and store that state on the UIComponent. During decoding, events may be + enqueued for later processing (by event listeners that have registered an interest), by calling + queueEvent() on the associated UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1935__OLD + + void + + jakarta.faces.render.Renderer.encodeBegin +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Render the beginning specified UIComponent to the output stream or writer associated + with the response we are creating. If the conversion attempted in a previous call to decode for this + component failed, the state information saved during execution of decode() should be utilized to + reproduce the incorrect input. If the conversion was successful, or if there was no previous call to + decode(), the value to be displayed should be acquired by calling component.currentValue(), and + rendering the value as appropriate. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1935 + + void + + jakarta.faces.render.Renderer.encodeBegin +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Render the beginning specified UIComponent to the output stream or writer associated + with the response we are creating. If the conversion attempted in a previous call to + getConvertedValue() for this component failed, the state information saved during execution of + decode() should be used to reproduce the incorrect input. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1976__OLD + + Iterator + + jakarta.faces.render.RenderKit.getRendererTypes +
+ ( + String + ) +
+
+ Return an Iterator of the renderer types of all Renderer instances registered with this + RenderKit that support components of the specified component type. If no Renderers support this + component type, an empty Iterator is returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1976 + + Iterator + + jakarta.faces.render.RenderKit.getRendererTypes +
+ ( + String + ) +
+
+ Return an Iterator over the renderer-type entries for the given component-family. If + the specified componentFamily is not known to this RenderKit implementation, return an empty + Iterator The default implementation of this method returns an empty Iterator + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1981__OLD + + void + + jakarta.faces.render.RenderKitFactory.addRenderKit +
+ ( + String + , +
+ RenderKit + ) +
+
+ Register a new RenderKit instance, associated with the specified renderKitId, to be + supported by this RenderKitFactory. This method may be called at any time, and makes the + corresponding RenderKit instance available throughout the remaining lifetime of this web + application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1981 + + void + + jakarta.faces.render.RenderKitFactory.addRenderKit +
+ ( + String + , +
+ RenderKit + ) +
+
+ Register the specified RenderKit instance, associated with the specified renderKitId, + to be supported by this RenderKitFactory, replacing any previously registered RenderKit for this + identifier. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1990__OLD + + Iterator + + jakarta.faces.render.RenderKitFactory.getRenderKitIds +
+
+
+ Return an Iterator over the set of render kit identifiers supported by this factory. + This set must include the value specified by RenderKitFactory.DEFAULT_RENDER_KIT. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:1990 + + Iterator + + jakarta.faces.render.RenderKitFactory.getRenderKitIds +
+
+
+ Return an Iterator over the set of render kit identifiers registered with this factory. + This set must include the value specified by RenderKitFactory.HTML_BASIC_RENDER_KIT. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2004__OLD + + double + + jakarta.faces.validator.DoubleRangeValidator.getMaximum +
+
+
+ Return the maximum value to be enforced by this Validator, if isMaximumSet() returns + true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2004 + + double + + jakarta.faces.validator.DoubleRangeValidator.getMaximum +
+
+
+ Return the maximum value to be enforced by this Validator or Double.MAX_VALUE if it has + not been set. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2005__OLD + + double + + jakarta.faces.validator.DoubleRangeValidator.getMinimum +
+
+
+ Return the minimum value to be enforced by this Validator, if isMinimumSet() returns + true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2005 + + double + + jakarta.faces.validator.DoubleRangeValidator.getMinimum +
+
+
+ Return the minimum value to be enforced by this Validator, or Double.MIN_VALUE if it + has not been set. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2014__OLD + + int + + jakarta.faces.validator.LengthValidator.getMaximum +
+
+
+ Return the maximum length to be enforced by this Validator, if isMaximumSet() returns + true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2014 + + int + + jakarta.faces.validator.LengthValidator.getMaximum +
+
+
+ Return the maximum length to be enforced by this Validator, or 0 if the maximum has not + been set. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2015__OLD + + int + + jakarta.faces.validator.LengthValidator.getMinimum +
+
+
+ Return the minimum length to be enforced by this Validator, if isMinimumSet() returns + true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2015 + + int + + jakarta.faces.validator.LengthValidator.getMinimum +
+
+
+ Return the minimum length to be enforced by this Validator, or 0 if the minimum has not + been set. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2027__OLD + + long + + jakarta.faces.validator.LongRangeValidator.getMaximum +
+
+
+ Return the maximum value to be enforced by this Validator, if isMaximumSet() returns + true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2027 + + long + + jakarta.faces.validator.LongRangeValidator.getMaximum +
+
+
+ Return the maximum value to be enforced by this Validator. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2028__OLD + + long + + jakarta.faces.validator.LongRangeValidator.getMinimum +
+
+
+ Return the minimum value to be enforced by this Validator, if isMinimumSet() returns + true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2028 + + long + + jakarta.faces.validator.LongRangeValidator.getMinimum +
+
+
+ Return the minimum value to be enforced by this Validator. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2219 + + Object + + jakarta.faces.FacesWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2220 + + void + + jakarta.faces.FactoryFinder.setFactory +
+ ( + String + , +
+ String + ) +
+
+ This method will store the argument factoryName/implName mapping in such a way that + #getFactory will find this mapping when searching for a match. This method has no effect if + getFactory() has already been called looking for a factory for this factoryName. This method can be + used by implementations to store a factory mapping while parsing the Faces configuration file + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2221 + + Literal + + jakarta.faces.annotation.ApplicationMap.Literal.ApplicationMap.Literal +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2222 + + Version + + jakarta.faces.annotation.FacesConfig.version +
+
+
+ The value of this attribute indicates that features corresponding to this version must + be enabled for this application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2223 + + Literal + + jakarta.faces.annotation.FacesConfig.Literal.FacesConfig.Literal +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2224 + + Version + + jakarta.faces.annotation.FacesConfig.Literal.version +
+
+
+ The value of this attribute indicates that features corresponding to this version must + be enabled for this application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2225 + + Version + + jakarta.faces.annotation.FacesConfig.Version.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2226 + + Version[] + + jakarta.faces.annotation.FacesConfig.Version.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2227 + + Literal + + jakarta.faces.annotation.FlowMap.Literal.FlowMap.Literal +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2228 + + Literal + + jakarta.faces.annotation.HeaderMap.Literal.HeaderMap.Literal +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2229 + + Literal + + jakarta.faces.annotation.HeaderValuesMap.Literal.HeaderValuesMap.Literal +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2230 + + Literal + + jakarta.faces.annotation.InitParameterMap.Literal.InitParameterMap.Literal +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2231 + + String + + jakarta.faces.annotation.ManagedProperty.value +
+
+
+ Taken to be the value that is injected into the field. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2232 + + Literal + + jakarta.faces.annotation.ManagedProperty.Literal.of +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2233 + + String + + jakarta.faces.annotation.ManagedProperty.Literal.value +
+
+
+ Taken to be the value that is injected into the field. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2234 + + Literal + + jakarta.faces.annotation.RequestCookieMap.Literal.RequestCookieMap.Literal +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2235 + + Literal + + jakarta.faces.annotation.RequestMap.Literal.RequestMap.Literal +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2236 + + Literal + + jakarta.faces.annotation.RequestParameterMap.Literal.RequestParameterMap.Literal +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2237 + + Literal + + + jakarta.faces.annotation.RequestParameterValuesMap.Literal.RequestParameterValuesMap.Literal +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2238 + + Literal + + jakarta.faces.annotation.SessionMap.Literal.SessionMap.Literal +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2239 + + String + + jakarta.faces.annotation.View.value +
+
+
+ Set the Faces View Id pattern. The Faces View Id pattern can represent a single view, + such as "/index.xhtml", or a pattern like "/foo/bar/*". Though the exact interpretation of the Faces + View Id for a single view is ultimately defined by the annotated element, in general it should align + with the return value from an action expression (see + ActionSource2#setActionExpression(jakarta.el.MethodExpression) + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2240 + + Literal + + jakarta.faces.annotation.View.Literal.of +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2241 + + String + + jakarta.faces.annotation.View.Literal.value +
+
+
+ Set the Faces View Id pattern. The Faces View Id pattern can represent a single view, + such as "/index.xhtml", or a pattern like "/foo/bar/*". Though the exact interpretation of the Faces + View Id for a single view is ultimately defined by the annotated element, in general it should align + with the return value from an action expression (see + ActionSource2#setActionExpression(jakarta.el.MethodExpression) + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2242 + + Literal + + jakarta.faces.annotation.ViewMap.Literal.ViewMap.Literal +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2243 + + void + + jakarta.faces.application.Application.addBehavior +
+ ( + String + , +
+ String + ) +
+
+ Register a new mapping of behavior id to the name of the corresponding Behavior class. + This allows subsequent calls to createBehavior() to serve as a factory for Behavior instances. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2244 + + void + + jakarta.faces.application.Application.addComponent +
+ ( + String + , +
+ String + ) +
+
+ Register a new mapping of component type to the name of the corresponding UIComponent + class. This allows subsequent calls to createComponent() to serve as a factory for UIComponent + instances. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2245 + + void + + jakarta.faces.application.Application.addConverter +
+ ( + String + , +
+ String + ) +
+
+ Register a new mapping of converter id to the name of the corresponding Converter + class. This allows subsequent calls to createConverter() to serve as a factory for Converter + instances. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2246 + + void + + jakarta.faces.application.Application.addConverter +
+ ( + Class + , +
+ String + ) +
+
+ Register a new converter class that is capable of performing conversions for the + specified target class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2247 + + void + + jakarta.faces.application.Application.addDefaultValidatorId +
+ ( + String + ) +
+
+ Register a validator by its id that is applied to all UIInput components in a view. The + validator to most often serve this role is the BeanValidator. The usage contract for this method + assumes that the validator has been registered using the normal #8220;by-id #8221; registration + mechanism. An implementation is provided that takes no action so that users that decorate the + Application continue to work. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2248 + + void + + jakarta.faces.application.Application.addELContextListener +
+ ( + ELContextListener + ) +
+
+ Provide a way for Faces applications to register an ELContextListener that will be + notified on creation of ELContext instances. This listener will be called once per request. An + implementation is provided that throws UnsupportedOperationException so that users that decorate the + Application continue to work. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2249 + + void + + jakarta.faces.application.Application.addELResolver +
+ ( + ELResolver + ) +
+
+ Cause an the argument resolver to be added to the resolver chain as specified in + section 5.3.2 "ELResolver" of the Jakarta Faces Specification Document. It is not possible to remove + an ELResolver registered with this method, once it has been registered. It is illegal to register an + ELResolver after the application has received any requests from the client. If an attempt is made to + register a listener after that time, an IllegalStateException must be thrown. This restriction is in + place to allow the Jakarta Server Pages container to optimize for the common case where no + additional ELResolvers are in the chain, aside from the standard ones. It is permissible to add + ELResolvers before or after initialization to a CompositeELResolver that is already in the chain. + The default implementation throws UnsupportedOperationException and is provided for the sole purpose + of not breaking existing applications that extend Application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2250 + + void + + jakarta.faces.application.Application.addSearchKeywordResolver +
+ ( + SearchKeywordResolver + ) +
+
+ Cause the argument resolver to be added to the head of the resolver chain. It is not + possible to remove a SearchKeywordResolver registered with this method, once it has been registered. + The default implementation throws UnsupportedOperationException and is provided for the sole purpose + of not breaking existing applications that extend Application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2251 + + void + + jakarta.faces.application.Application.addValidator +
+ ( + String + , +
+ String + ) +
+
+ Register a new mapping of validator id to the name of the corresponding Validator + class. This allows subsequent calls to createValidator() to serve as a factory for Validator + instances. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2252 + + Behavior + + jakarta.faces.application.Application.createBehavior +
+ ( + String + ) +
+
+ Instantiate and return a new Behavior instance of the class specified by a previous + call to addBehavior() for the specified behavior id. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2253 + + Behavior + + jakarta.faces.application.Application.createBehavior +
+ ( + String + ) + +
+ throws + FacesException +
+
+
+ if the Behavior cannot be created + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2254 + + UIComponent + + jakarta.faces.application.Application.createComponent +
+ ( + String + ) +
+
+ Instantiate and return a new UIComponent instance of the class specified by a previous + call to addComponent() for the specified component type. Before the component instance is returned, + it must be inspected for the presence of a jakarta.faces.event.ListenerFor (or + jakarta.faces.event.ListenersFor) or ResourceDependency (or ResourceDependencies) annotation. If any + of these annotations are present, the action listed in jakarta.faces.event.ListenerFor or + ResourceDependency must be taken on the component, before it is returned from this method. This + variant of createComponent must not inspect the jakarta.faces.render.Renderer for the component to + be returned for any of the afore mentioned annotations. Such inspection is the province of + #createComponent(ValueExpression, FacesContext, String, String) or #createComponent(FacesContext, + String, String). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2255 + + UIComponent + + jakarta.faces.application.Application.createComponent +
+ ( + String + ) + +
+ throws + FacesException +
+
+
+ if a UIComponent of the specified type cannot be created + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2256 + + UIComponent + + jakarta.faces.application.Application.createComponent +
+ ( + ValueExpression + , +
+ FacesContext + , +
+ String + ) +
+
+ Call the getValue() method on the specified ValueExpression. If it returns a + UIComponent instance, return it as the value of this method. If it does not, instantiate a new + UIComponent instance of the specified component type, pass the new component to the setValue() + method of the specified ValueExpression, and return it. Before the component instance is returned, + it must be inspected for the presence of a jakarta.faces.event.ListenerFor (or + jakarta.faces.event.ListenersFor) or ResourceDependency (or ResourceDependencies) annotation. If any + of these annotations are present, the action listed in jakarta.faces.event.ListenerFor or + ResourceDependency must be taken on the component, before it is returned from this method. This + variant of createComponent must not inspect the jakarta.faces.render.Renderer for the component to + be returned for any of the afore mentioned annotations. Such inspection is the province of + #createComponent(ValueExpression, FacesContext, String, String) or #createComponent(FacesContext, + String, String). A default implementation is provided that throws UnsupportedOperationException so + that users that decorate Application can continue to function. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2257 + + UIComponent + + jakarta.faces.application.Application.createComponent +
+ ( + ValueExpression + , +
+ FacesContext + , +
+ String + ) + +
+ throws + FacesException +
+
+
+ if a UIComponent cannot be created + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2258 + + UIComponent + + jakarta.faces.application.Application.createComponent +
+ ( + ValueExpression + , +
+ FacesContext + , +
+ String + , +
+ String + ) +
+
+ Like #createComponent(ValueExpression, FacesContext, String) except the Renderer for + the component to be returned must be inspected for the annotations mentioned in + #createComponent(ValueExpression, FacesContext, String) as specified in the documentation for that + method. The Renderer instance to inspect must be obtained by calling FacesContext#getRenderKit and + calling jakarta.faces.render.RenderKit#getRenderer on the result, passing the argument componentType + as the first argument and the result of calling UIComponent#getFamily on the newly created component + as the second argument. If no such Renderer can be found, a message must be logged with a helpful + error message. Otherwise, UIComponent#setRendererType must be called on the newly created + UIComponent instance, passing the argument rendererType as the argument. A default implementation is + provided that throws UnsupportedOperationException so that users that decorate Application can + continue to function. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2259 + + UIComponent + + jakarta.faces.application.Application.createComponent +
+ ( + FacesContext + , +
+ String + , +
+ String + ) +
+
+ Like #createComponent(String) except the Renderer for the component to be returned must + be inspected for the annotations mentioned in #createComponent(ValueExpression, FacesContext, + String) as specified in the documentation for that method. The Renderer instance to inspect must be + obtained by calling FacesContext#getRenderKit and calling jakarta.faces.render.RenderKit#getRenderer + on the result, passing the argument componentType as the first argument and the result of calling + UIComponent#getFamily on the newly created component as the second argument. If no such Renderer can + be found, a message must be logged with a helpful error message. Otherwise, + UIComponent#setRendererType must be called on the newly created UIComponent instance, passing the + argument rendererType as the argument. A default implementation is provided that throws + UnsupportedOperationException so that users that decorate Application can continue to function . + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2260 + + UIComponent + + jakarta.faces.application.Application.createComponent +
+ ( + FacesContext + , +
+ Resource + ) +
+
+ Instantiate and return a new UIComponent instance from the argument Resource. An + algorithm semantically equivalent to the following must be followed to instantiate the UIComponent + to return. Obtain a reference to the ViewDeclarationLanguage for this Application instance by + calling ViewHandler#getViewDeclarationLanguage, passing the viewId found by calling + jakarta.faces.component.UIViewRoot#getViewId on the jakarta.faces.component.UIViewRoot in the + argument FacesContext. Obtain a reference to the composite component metadata for this composite + component by calling ViewDeclarationLanguage#getComponentMetadata, passing the facesContext and + componentResource arguments to this method. This version of the Jakarta Faces Specification uses + JavaBeans as the API to the component metadata. Determine if the component author declared a + componentType for this component instance by obtaining the BeanDescriptor from the component + metadata and calling its getValue() method, passing UIComponent#COMPOSITE_COMPONENT_TYPE_KEY as the + argument. If non-null, the result must be a ValueExpression whose value is the component-type of the + UIComponent to be created for this Resource component. Call through to + #createComponent(java.lang.String) to create the component. Otherwise, determine if a script based + component for this Resource can be found by calling + ViewDeclarationLanguage#getScriptComponentResource. If the result is non-null, and is a script + written in a language satisfying the content type text/javascript, create a UIComponent instance + from the script resource. Otherwise, let library-name be the return from calling + Resource#getLibraryName on the argument componentResource and resource-name be the return from + calling Resource#getResourceName on the argument componentResource. Create a fully qualified Java + class name by removing any file extension from resource-name and let fqcn be library-name + "." + + resource-name. If a class with the name of fqcn cannot be found, take no action and continue to the + next step. If any of InstantiationException, IllegalAccessException, or ClassCastException are + thrown, wrap the exception in a FacesException and re-throw it. If any other exception is thrown, + log the exception and continue to the next step. If none of the previous steps have yielded a + UIComponent instance, call #createComponent(java.lang.String) passing + "jakarta.faces.NamingContainer" as the argument. Call UIComponent#setRendererType on the UIComponent + instance, passing "jakarta.faces.Composite" as the argument. Store the argument Resource in the + attributes Map of the UIComponent under the key, Resource#COMPONENT_RESOURCE_KEY. Store composite + component metadata in the attributes Map of the UIComponent under the key, UIComponent#BEANINFO_KEY. + Before the component instance is returned, it must be inspected for the presence of a + jakarta.faces.event.ListenerFor annotation. If this annotation is present, the action listed in + jakarta.faces.event.ListenerFor must be taken on the component, before it is returned from this + method. A default implementation is provided that throws UnsupportedOperationException so that users + that decorate Application can continue to function. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2261 + + Converter + + jakarta.faces.application.Application.createConverter +
+ ( + String + ) +
+
+ Instantiate and return a new Converter instance of the class specified by a previous + call to addConverter() for the specified converter id. If the toLowerCase() of the String + represenation of the value of the + "jakarta.faces.DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE" application configuration + parameter is "true" (without the quotes) and the Converter instance to be returned is an instance of + jakarta.faces.convert.DateTimeConverter, jakarta.faces.convert.DateTimeConverter#setTimeZone must be + called, passing the return from TimeZone.getDefault(). The argument converter must be inspected for + the presence of the jakarta.faces.application.ResourceDependency annotation. If the + ResourceDependency annotation is present, the action described in ResourceDependency must be taken. + If the ResourceDependency annotation is not present, the argument converter must be inspected for + the presence of the jakarta.faces.application.ResourceDependencies annotation. If the + ResourceDependencies annotation is present, the action described in ResourceDependencies must be + taken. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2262 + + Converter + + jakarta.faces.application.Application.createConverter +
+ ( + Class + ) +
+
+ Instantiate and return a new Converter instance of the class that has registered itself + as capable of performing conversions for objects of the specified type. If no such Converter class + can be identified, return null. To locate an appropriate Converter class, the following algorithm is + performed, stopping as soon as an appropriate Converter class is found: Locate a Converter + registered for the target class itself. Locate a Converter registered for interfaces that are + implemented by the target class (directly or indirectly). Locate a Converter registered for the + superclass (if any) of the target class, recursively working up the inheritance hierarchy. If the + Converter has a single argument constructor that accepts a Class, instantiate the Converter using + that constructor, passing the argument targetClass as the sole argument. Otherwise, simply use the + zero-argument constructor. If the toLowerCase() of the String represenation of the value of the + "jakarta.faces.DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE" application configuration + parameter is "true" (without the quotes) and the Converter instance to be returned is an instance of + jakarta.faces.convert.DateTimeConverter, jakarta.faces.convert.DateTimeConverter#setTimeZone must be + called, passing the return from TimeZone.getDefault(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2263 + + Validator + + jakarta.faces.application.Application.createValidator +
+ ( + String + ) +
+
+ Instantiate and return a new Validator instance of the class specified by a previous + call to addValidator() for the specified validator id. The argument validator must be inspected for + the presence of the jakarta.faces.application.ResourceDependency annotation. If the + ResourceDependency annotation is present, the action described in ResourceDependency must be taken. + If the ResourceDependency annotation is not present, the argument validator must be inspected for + the presence of the jakarta.faces.application.ResourceDependencies annotation. If the + ResourceDependencies annotation is present, the action described in ResourceDependencies must be + taken. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2264 + + Validator + + jakarta.faces.application.Application.createValidator +
+ ( + String + ) + +
+ throws + FacesException +
+
+
+ if a Validator of the specified id cannot be created + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2265 + + Object + + jakarta.faces.application.Application.evaluateExpressionGet +
+ ( + FacesContext + , +
+ String + , +
+ Class + ) +
+
+ Get a value by evaluating an expression. Call #getExpressionFactory then call + ExpressionFactory#createValueExpression passing the argument expression and expectedType. Call + FacesContext#getELContext and pass it to ValueExpression#getValue, returning the result. An + implementation is provided that throws UnsupportedOperationException so that users that decorate the + Application continue to work. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2266 + + Object + + jakarta.faces.application.Application.evaluateExpressionGet +
+ ( + FacesContext + , +
+ String + , +
+ Class + ) + +
+ throws + ELException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2267 + + Iterator + + jakarta.faces.application.Application.getBehaviorIds +
+
+
+ Return an Iterator over the set of currently registered behavior ids for this + Application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2268 + + Iterator + + jakarta.faces.application.Application.getComponentTypes +
+
+
+ Return an Iterator over the set of currently defined component types for this + Application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2269 + + Iterator + + jakarta.faces.application.Application.getConverterIds +
+
+
+ Return an Iterator over the set of currently registered converter ids for this + Application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2270 + + Iterator + + jakarta.faces.application.Application.getConverterTypes +
+
+
+ Return an Iterator over the set of Class instances for which Converter classes have + been explicitly registered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2271 + + Locale + + jakarta.faces.application.Application.getDefaultLocale +
+
+
+ Return the default Locale for this application. If not explicitly set, null is + returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2272 + + String + + jakarta.faces.application.Application.getDefaultRenderKitId +
+
+
+ Return the renderKitId to be used for rendering this application. If not explicitly + set, null is returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2273 + + Map + + jakarta.faces.application.Application.getDefaultValidatorInfo +
+
+
+ Return an immutable Map over the set of currently registered default validator IDs and + their class name for this Application. An implementation is provided that returns + Collections.emptyMap so that users that decorate the Application continue to work. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2274 + + ELContextListener[] + + jakarta.faces.application.Application.getELContextListeners +
+
+
+ If no calls have been made to #addELContextListener, this method must return an empty + array. Otherwise, return an array representing the list of listeners added by calls to + #addELContextListener. An implementation is provided that throws UnsupportedOperationException so + that users that decorate the Application continue to work. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2275 + + ELResolver + + jakarta.faces.application.Application.getELResolver +
+
+
+ Return the singleton ELResolver instance to be used for all Jakarta Expression Language + resolution. This is actually an instance of jakarta.el.CompositeELResolver that must contain the + following ELResolver instances in the following order: ELResolver instances declared using the + element in the application configuration resources. An implementation that wraps the head of the + legacy VariableResolver chain, as per section VariableResolver ChainWrapper in Chapter 5 in the spec + document. An implementation that wraps the head of the legacy PropertyResolver chain, as per section + PropertyResolver ChainWrapper in Chapter 5 in the spec document. Any ELResolver instances added by + calls to #addELResolver. The default implementation throws UnsupportedOperationException and is + provided for the sole purpose of not breaking existing applications that extend Application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2276 + + ExpressionFactory + + jakarta.faces.application.Application.getExpressionFactory +
+
+
+ Return the ExpressionFactory instance for this application. This instance is used by + the convenience method #evaluateExpressionGet. The implementation must return the ExpressionFactory + from the Expression Language container by calling jakarta.el.ELManager.getExpressionFactory(). An + implementation is provided that throws UnsupportedOperationException so that users that decorate the + Application continue to work. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2277 + + FlowHandler + + jakarta.faces.application.Application.getFlowHandler +
+
+
+ Return the thread-safe singleton FlowHandler for this application. For implementations + declaring compliance with version 2.2 of the specification, this method must never return null, even + if the application has no flows. This is necessary to enable dynamic flow creation during the + application's lifetime. All implementations that declare compliance with version 2.2 of the + specification must implement this method. For the purpose of backward compatibility with + environments that extend Application but do not override this method, an implementation is provided + that returns null. Due to the decoratable nature of Application, code calling this method should + always check for a null return. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2278 + + String + + jakarta.faces.application.Application.getMessageBundle +
+
+
+ Return the fully qualified class name of the ResourceBundle to be used for Jakarta + Faces messages for this application. If not explicitly set, null is returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2279 + + ProjectStage + + jakarta.faces.application.Application.getProjectStage +
+
+
+ Return the project stage for the currently running application instance. The default + value is ProjectStage#Production The implementation of this method must perform the following + algorithm or an equivalent with the same end result to determine the value to return. If the value + has already been determined by a previous call to this method, simply return that value. Look for a + JNDI environment entry under the key given by the value of ProjectStage#PROJECT_STAGE_JNDI_NAME + (return type of java.lang.String). If found, continue with the algorithm below, otherwise, look for + an entry in the initParamMap of the ExternalContext from the current FacesContext with the key given + by the value of ProjectStage#PROJECT_STAGE_PARAM_NAME If a value is found, see if an enum constant + can be obtained by calling ProjectStage.valueOf(), passing the value from the initParamMap. If this + succeeds without exception, save the value and return it. If not found, or any of the previous + attempts to discover the enum constant value have failed, log a descriptive error message, assign + the value as ProjectStage.Production and return it. A default implementation is provided that throws + UnsupportedOperationException so that users that decorate Application can continue to function . + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2280 + + ResourceBundle + + jakarta.faces.application.Application.getResourceBundle +
+ ( + FacesContext + , +
+ String + ) +
+
+ Find a ResourceBundle as defined in the application configuration resources under the + specified name. If a ResourceBundle was defined for the name, return an instance that uses the + locale of the current jakarta.faces.component.UIViewRoot. The default implementation throws + UnsupportedOperationException and is provided for the sole purpose of not breaking existing + applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2281 + + ResourceHandler + + jakarta.faces.application.Application.getResourceHandler +
+
+
+ Return the singleton, stateless, thread-safe ResourceHandler for this application. The + Jakarta Faces implementation must support the following techniques for declaring an alternate + implementation of ResourceHandler. The ResourceHandler implementation is declared in the application + configuration resources by giving the fully qualified class name as the value of the element within + the element. In all of the above cases, the runtime must employ the decorator pattern as for every + other pluggable artifact in Jakarta Faces. A default implementation is provided that throws + UnsupportedOperationException so that users that decorate Application can continue to function . + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2282 + + SearchExpressionHandler + + jakarta.faces.application.Application.getSearchExpressionHandler +
+
+
+ Return the thread-safe singleton SearchExpressionHandler for this application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2283 + + SearchKeywordResolver + + jakarta.faces.application.Application.getSearchKeywordResolver +
+
+
+ Return the singleton SearchKeywordResolver instance to be used for all search keyword + resolution. This is actually an instance of a composite SearchKeywordResolver that must contain the + following SearchKeywordResolver instances in the following order: SearchKeywordResolver instances + declared using the element in the application configuration resources. Any SearchKeywordResolver + instances added by calls to #addSearchKeywordResolver. The SearchKeywordResolver implementations for + @all, @child(n), @form, @id(...), @namingcontainer, @next, @none, @parent, @previous, @root and + @this. The default implementation throws UnsupportedOperationException and is provided for the sole + purpose of not breaking existing applications that extend Application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2284 + + StateManager + + jakarta.faces.application.Application.getStateManager +
+
+
+ Return the StateManager instance that will be utilized during the Restore View and + Render Response phases of the request processing lifecycle. If not explicitly set, a default + implementation must be provided that performs the functions described in the StateManager + description in the Jakarta Faces Specification. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2285 + + Iterator + + jakarta.faces.application.Application.getSupportedLocales +
+
+
+ Return an Iterator over the supported Locales for this appication. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2286 + + Iterator + + jakarta.faces.application.Application.getValidatorIds +
+
+
+ Return an Iterator over the set of currently registered validator ids for this + Application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2287 + + ViewHandler + + jakarta.faces.application.Application.getViewHandler +
+
+
+ Return the ViewHandler instance that will be utilized during the Restore View and + Render Response phases of the request processing lifecycle. If not explicitly set, a default + implementation must be provided that performs the functions described in the ViewHandler description + in the Jakarta Faces Specification. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2288 + + void + + jakarta.faces.application.Application.publishEvent +
+ ( + FacesContext + , +
+ Class + , +
+ Object + ) +
+
+ If jakarta.faces.context.FacesContext#isProcessingEvents() is true and there are one or + more listeners for events of the type represented by systemEventClass, call those listeners, passing + source as the source of the event. The implementation should be as fast as possible in determining + whether or not a listener for the given systemEventClass and source has been installed, and should + return immediately once such a determination has been made. The implementation of publishEvent must + honor the requirements stated in #subscribeToEvent regarding the storage and retrieval of listener + instances. Specifically, if #subscribeToEvent(Class,Class,SystemEventListener) was called, the + sourceClass argument must match exactly the Class of the source argument in the call to + publishEvent(). The implementation must not do any inheritance hierarachy inspection when looking + for a match between the sourceClass passed to #subscribeToEvent(Class,Class,SystemEventListener) and + the sourceClass passed to publishEvent() in order to find any listeners to which the event should be + published. In the case where the Class of the source argument does not match the Class of the + sourceClass used when the listener was subscribed using subscribeToEvent(), + #publishEvent(FacesContext,Class,Class,Object) can be used to provide the Class used to perform the + listener lookup and match. The default implementation must implement an algorithm semantically + equivalent to the following to locate listener instances and to invoke them. If the source argument + implements jakarta.faces.event.SystemEventListenerHolder, call + jakarta.faces.event.SystemEventListenerHolder#getListenersForEventClass on it, passing the + systemEventClass argument. If the list is not empty, perform algorithm traverseListenerList on the + list. If any view level listeners have been installed by previous calls to #subscribeToEvent(Class, + Class, jakarta.faces.event.SystemEventListener) on the jakarta.faces.component.UIViewRoot, perform + algorithm traverseListenerList on the list of listeners for that event installed on the UIViewRoot. + If any Application level listeners have been installed by previous calls to #subscribeToEvent(Class, + Class, jakarta.faces.event.SystemEventListener), perform algorithm traverseListenerList on the list. + If any Application level listeners have been installed by previous calls to #subscribeToEvent(Class, + jakarta.faces.event.SystemEventListener), perform algorithm traverseListenerList on the list. If the + act of invoking the processListener method causes an jakarta.faces.event.AbortProcessingException to + be thrown, processing of the listeners must be aborted, no further processing of the listeners for + this event must take place, and the exception must be logged with Level.SEVERE. Algorithm + traverseListenerList: For each listener in the list, Call + jakarta.faces.event.SystemEventListener#isListenerForSource, passing the source argument. If this + returns false, take no action on the listener. Otherwise, if the event to be passed to the listener + instances has not yet been constructed, construct the event, passing source as the argument to the + one-argument constructor that takes an Object. This same event instance must be passed to all + listener instances. Call jakarta.faces.event.SystemEvent#isAppropriateListener, passing the listener + instance as the argument. If this returns false, take no action on the listener. Call + jakarta.faces.event.SystemEvent#processListener, passing the listener instance. A default + implementation is provided that throws UnsupportedOperationException so that users that decorate + Application can continue to function . + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2289 + + void + + jakarta.faces.application.Application.publishEvent +
+ ( + FacesContext + , +
+ Class + , +
+ Class + , +
+ Object + ) +
+
+ This method functions exactly like #publishEvent(FacesContext,Class,Object), except the + run-time must use the argument sourceBaseType to find the matching listener instead of using the + Class of the source argument. A default implementation is provided that throws + UnsupportedOperationException so that users that decorate Application can continue to function . + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2290 + + void + + jakarta.faces.application.Application.removeELContextListener +
+ ( + ELContextListener + ) +
+
+ Remove the argument listener from the list of ELContextListeners. If listener is null, + no exception is thrown and no action is performed. If listener is not in the list, no exception is + thrown and no action is performed. An implementation is provided that throws + UnsupportedOperationException so that users that decorate the Application continue to work. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2291 + + void + + jakarta.faces.application.Application.setDefaultLocale +
+ ( + Locale + ) +
+
+ Set the default Locale for this application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2292 + + void + + jakarta.faces.application.Application.setDefaultRenderKitId +
+ ( + String + ) +
+
+ Set the renderKitId to be used to render this application. Unless the client has + provided a custom ViewHandler that supports the use of multiple jakarta.faces.render.RenderKit + instances in the same application, this method must only be called at application startup, before + any Faces requests have been processed. This is a limitation of the current Specification, and may + be lifted in a future release. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2293 + + void + + jakarta.faces.application.Application.setFlowHandler +
+ ( + FlowHandler + ) +
+
+ Set the FlowHandler instance used by the NavigationHandler to satisfy the requirements + of the faces flows feature. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2294 + + void + + jakarta.faces.application.Application.setMessageBundle +
+ ( + String + ) +
+
+ Set the fully qualified class name of the ResourceBundle to be used for Jakarta Faces + messages for this application. See the JavaDocs for the java.util.ResourceBundle class for more + information about the syntax for resource bundle names. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2295 + + void + + jakarta.faces.application.Application.setResourceHandler +
+ ( + ResourceHandler + ) +
+
+ Set the ResourceHandler instance that will be utilized for rendering the markup for + resources, and for satisfying client requests to serve up resources. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2296 + + void + + jakarta.faces.application.Application.setSearchExpressionHandler +
+ ( + SearchExpressionHandler + ) +
+
+ Set the SearchExpressionHandler instance used by the application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2297 + + void + + jakarta.faces.application.Application.setStateManager +
+ ( + StateManager + ) +
+
+ Set the StateManager instance that will be utilized during the Restore View and Render + Response phases of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2298 + + void + + jakarta.faces.application.Application.setSupportedLocales +
+ ( + Collection + ) +
+
+ Set the Locale instances representing the supported Locales for this application. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2299 + + void + + jakarta.faces.application.Application.setViewHandler +
+ ( + ViewHandler + ) +
+
+ Set the ViewHandler instance that will be utilized during the Restore View and Render + Response phases of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2300 + + void + + jakarta.faces.application.Application.subscribeToEvent +
+ ( + Class + , +
+ Class + , +
+ SystemEventListener + ) +
+
+ Install the listener instance referenced by argument listener into the application as a + listener for events of type systemEventClass that originate from objects of type sourceClass. If + argument sourceClass is non-null, sourceClass and systemEventClass must be used to store the + argument listener in the application in such a way that the listener can be quickly looked up by the + implementation of #publishEvent given systemEventClass and an instance of the Class referenced by + sourceClass. If argument sourceClass is null, the listener must be discoverable by the + implementation of #publishEvent given only systemEventClass. It is valid to call this method during + the processing of an event which was subscribed to by a previous call to this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2301 + + void + + jakarta.faces.application.Application.subscribeToEvent +
+ ( + Class + , +
+ SystemEventListener + ) +
+
+ Install the listener instance referenced by argument listener into application as a + listener for events of type systemEventClass. The default implementation simply calls through to + #subscribeToEvent(Class, Class, jakarta.faces.event.SystemEventListener) passing null as the + sourceClass argument A default implementation is provided that throws UnsupportedOperationException + so that users that decorate Application can continue to function . + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2302 + + void + + jakarta.faces.application.Application.unsubscribeFromEvent +
+ ( + Class + , +
+ Class + , +
+ SystemEventListener + ) +
+
+ Remove the listener instance referenced by argument listener from the application as a + listener for events of type systemEventClass that originate from objects of type sourceClass. See + #subscribeToEvent(Class, Class, jakarta.faces.event.SystemEventListener) for the specification of + how the listener is stored, and therefore, how it must be removed. See + #subscribeToEvent(java.lang.Class,java.lang.Class,jakarta.faces.event.SystemEventListener) for an + additional requirement regarding when it is valid to call this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2303 + + void + + jakarta.faces.application.Application.unsubscribeFromEvent +
+ ( + Class + , +
+ SystemEventListener + ) +
+
+ Remove the listener instance referenced by argument listener from the application as a + listener for events of type systemEventClass. The default implementation simply calls through to + #unsubscribeFromEvent(Class, jakarta.faces.event.SystemEventListener) passing null as the + sourceClass argument See + #subscribeToEvent(java.lang.Class,java.lang.Class,jakarta.faces.event.SystemEventListener) for an + additional requirement regarding when it is valid to call this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2304 + + ApplicationConfigurationPopulator + + + jakarta.faces.application.ApplicationConfigurationPopulator.ApplicationConfigurationPopulator +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2305 + + void + + + jakarta.faces.application.ApplicationConfigurationPopulator.populateApplicationConfiguration +
+ ( + Document + ) +
+
+ Service providers that implement this service must be called by the Jakarta Faces + runtime exactly once for each implementation, at startup, before any requests have been serviced. + Before calling the #populateApplicationConfiguration method, the runtime must ensure that the + Document argument is empty aside from being pre-configured to be in the proper namespace for an + Application Configuration Resources file: https://jakarta.ee/xml/ns/jakartaee. Implementations of + this service must ensure that any changes made to the argument Document conform to that schema as + defined in the specification. The Jakarta Faces runtime is not required to validate the Document + after control returns from the service implementation, though it may do so. Ordering of Artifacts If + the document is made to contain an element, as specified in the section 11.3.8 "Ordering of + Artifacts" in the Jakarta Faces Specification Document, the document will be prioritized + accordingly. Otherwise, the runtime must place the document in the list of other Application + Configuration Resources documents at the "lowest" priority, meaning any conflicts that may arise + between the argument document and any other Application Configuration Resources are resolved in + favor of the other document. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2306 + + ApplicationFactory + + jakarta.faces.application.ApplicationFactory.ApplicationFactory +
+ ( + ApplicationFactory + ) +
+
+ If this factory has been decorated, the implementation doing the decorating should push + the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2307 + + ApplicationFactory + + jakarta.faces.application.ApplicationFactory.getWrapped +
+
+
+ If this factory has been decorated, the implementation doing the decorating may + override this method to provide access to the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2308 + + void + + jakarta.faces.application.ApplicationWrapper.addBehavior +
+ ( + String + , +
+ String + ) +
+
+ The default behavior of this method is to call Application#addBehavior(String, String) + on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2309 + + void + + jakarta.faces.application.ApplicationWrapper.addComponent +
+ ( + String + , +
+ String + ) +
+
+ The default behavior of this method is to call Application#addComponent(String, String) + on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2310 + + void + + jakarta.faces.application.ApplicationWrapper.addConverter +
+ ( + String + , +
+ String + ) +
+
+ The default behavior of this method is to call Application#addConverter(String, String) + on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2311 + + void + + jakarta.faces.application.ApplicationWrapper.addConverter +
+ ( + Class + , +
+ String + ) +
+
+ The default behavior of this method is to call Application#addConverter(Class, String) + on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2312 + + void + + jakarta.faces.application.ApplicationWrapper.addDefaultValidatorId +
+ ( + String + ) +
+
+ The default behavior of this method is to call + Application#addDefaultValidatorId(String) on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2313 + + void + + jakarta.faces.application.ApplicationWrapper.addELContextListener +
+ ( + ELContextListener + ) +
+
+ The default behavior of this method is to call + Application#addELContextListener(jakarta.el.ELContextListener) on the wrapped Application object. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2314 + + void + + jakarta.faces.application.ApplicationWrapper.addELResolver +
+ ( + ELResolver + ) +
+
+ The default behavior of this method is to call + Application#addELResolver(jakarta.el.ELResolver) on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2315 + + void + + jakarta.faces.application.ApplicationWrapper.addSearchKeywordResolver +
+ ( + SearchKeywordResolver + ) +
+
+ Cause the argument resolver to be added to the head of the resolver chain. It is not + possible to remove a SearchKeywordResolver registered with this method, once it has been registered. + The default implementation throws UnsupportedOperationException and is provided for the sole purpose + of not breaking existing applications that extend Application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2316 + + void + + jakarta.faces.application.ApplicationWrapper.addValidator +
+ ( + String + , +
+ String + ) +
+
+ The default behavior of this method is to call Application#addValidator(String, String) + on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2317 + + ApplicationWrapper + + jakarta.faces.application.ApplicationWrapper.ApplicationWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:2318 + + ApplicationWrapper + + jakarta.faces.application.ApplicationWrapper.ApplicationWrapper +
+ ( + Application + ) +
+
+ If this application has been decorated, the implementation doing the decorating should + push the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2319 + + Behavior + + jakarta.faces.application.ApplicationWrapper.createBehavior +
+ ( + String + ) +
+
+ The default behavior of this method is to call Application#createBehavior(String) on + the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2320 + + Behavior + + jakarta.faces.application.ApplicationWrapper.createBehavior +
+ ( + String + ) + +
+ throws + FacesException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2321 + + UIComponent + + jakarta.faces.application.ApplicationWrapper.createComponent +
+ ( + String + ) +
+
+ The default behavior of this method is to call Application#createComponent(String) on + the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2322 + + UIComponent + + jakarta.faces.application.ApplicationWrapper.createComponent +
+ ( + String + ) + +
+ throws + FacesException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2323 + + UIComponent + + jakarta.faces.application.ApplicationWrapper.createComponent +
+ ( + ValueExpression + , +
+ FacesContext + , +
+ String + ) +
+
+ The default behavior of this method is to call + Application#createComponent(jakarta.el.ValueExpression, jakarta.faces.context.FacesContext, String) + on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2324 + + UIComponent + + jakarta.faces.application.ApplicationWrapper.createComponent +
+ ( + ValueExpression + , +
+ FacesContext + , +
+ String + ) + +
+ throws + FacesException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2325 + + UIComponent + + jakarta.faces.application.ApplicationWrapper.createComponent +
+ ( + ValueExpression + , +
+ FacesContext + , +
+ String + , +
+ String + ) +
+
+ The default behavior of this method is to call + Application#createComponent(jakarta.el.ValueExpression, jakarta.faces.context.FacesContext, String, + String) on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2326 + + UIComponent + + jakarta.faces.application.ApplicationWrapper.createComponent +
+ ( + FacesContext + , +
+ String + , +
+ String + ) +
+
+ The default behavior of this method is to call + Application#createComponent(jakarta.faces.context.FacesContext, String, String) on the wrapped + Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2327 + + UIComponent + + jakarta.faces.application.ApplicationWrapper.createComponent +
+ ( + FacesContext + , +
+ Resource + ) +
+
+ The default behavior of this method is to call + Application#createComponent(jakarta.faces.context.FacesContext, Resource) on the wrapped Application + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2328 + + Converter + + jakarta.faces.application.ApplicationWrapper.createConverter +
+ ( + String + ) +
+
+ The default behavior of this method is to call Application#createConverter(String) on + the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2329 + + Converter + + jakarta.faces.application.ApplicationWrapper.createConverter +
+ ( + Class + ) +
+
+ The default behavior of this method is to call Application#createConverter(Class) on + the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2330 + + Validator + + jakarta.faces.application.ApplicationWrapper.createValidator +
+ ( + String + ) +
+
+ The default behavior of this method is to call Application#createValidator(String) on + the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2331 + + Validator + + jakarta.faces.application.ApplicationWrapper.createValidator +
+ ( + String + ) + +
+ throws + FacesException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2332 + + Object + + jakarta.faces.application.ApplicationWrapper.evaluateExpressionGet +
+ ( + FacesContext + , +
+ String + , +
+ Class + ) +
+
+ The default behavior of this method is to call + Application#evaluateExpressionGet(jakarta.faces.context.FacesContext, String, Class) on the wrapped + Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2333 + + Object + + jakarta.faces.application.ApplicationWrapper.evaluateExpressionGet +
+ ( + FacesContext + , +
+ String + , +
+ Class + ) + +
+ throws + ELException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2334 + + ActionListener + + jakarta.faces.application.ApplicationWrapper.getActionListener +
+
+
+ The default behavior of this method is to call Application#getActionListener on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2335 + + Iterator + + jakarta.faces.application.ApplicationWrapper.getBehaviorIds +
+
+
+ The default behavior of this method is to call Application#getBehaviorIds on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2336 + + Iterator + + jakarta.faces.application.ApplicationWrapper.getComponentTypes +
+
+
+ The default behavior of this method is to call Application#getComponentTypes on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2337 + + Iterator + + jakarta.faces.application.ApplicationWrapper.getConverterIds +
+
+
+ The default behavior of this method is to call Application#getConverterIds on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2338 + + Iterator + + jakarta.faces.application.ApplicationWrapper.getConverterTypes +
+
+
+ The default behavior of this method is to call Application#getConverterTypes on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2339 + + Locale + + jakarta.faces.application.ApplicationWrapper.getDefaultLocale +
+
+
+ The default behavior of this method is to call Application#getDefaultLocale on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2340 + + String + + jakarta.faces.application.ApplicationWrapper.getDefaultRenderKitId +
+
+
+ The default behavior of this method is to call Application#getDefaultRenderKitId on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2341 + + Map + + jakarta.faces.application.ApplicationWrapper.getDefaultValidatorInfo +
+
+
+ The default behavior of this method is to call Application#getDefaultValidatorInfo on + the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2342 + + ELContextListener[] + + jakarta.faces.application.ApplicationWrapper.getELContextListeners +
+
+
+ The default behavior of this method is to call Application#getELContextListeners on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2343 + + ELResolver + + jakarta.faces.application.ApplicationWrapper.getELResolver +
+
+
+ The default behavior of this method is to call Application#getELResolver on the wrapped + Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2344 + + ExpressionFactory + + jakarta.faces.application.ApplicationWrapper.getExpressionFactory +
+
+
+ The default behavior of this method is to call Application#getExpressionFactory on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2345 + + FlowHandler + + jakarta.faces.application.ApplicationWrapper.getFlowHandler +
+
+
+ Return the thread-safe singleton FlowHandler for this application. For implementations + declaring compliance with version 2.2 of the specification, this method must never return null, even + if the application has no flows. This is necessary to enable dynamic flow creation during the + application's lifetime. All implementations that declare compliance with version 2.2 of the + specification must implement this method. For the purpose of backward compatibility with + environments that extend Application but do not override this method, an implementation is provided + that returns null. Due to the decoratable nature of Application, code calling this method should + always check for a null return. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2346 + + String + + jakarta.faces.application.ApplicationWrapper.getMessageBundle +
+
+
+ The default behavior of this method is to call Application#getMessageBundle on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2347 + + NavigationHandler + + jakarta.faces.application.ApplicationWrapper.getNavigationHandler +
+
+
+ The default behavior of this method is to call Application#getNavigationHandler on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2348 + + ProjectStage + + jakarta.faces.application.ApplicationWrapper.getProjectStage +
+
+
+ The default behavior of this method is to call Application#getProjectStage on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2349 + + ResourceBundle + + jakarta.faces.application.ApplicationWrapper.getResourceBundle +
+ ( + FacesContext + , +
+ String + ) +
+
+ The default behavior of this method is to call + Application#getResourceBundle(jakarta.faces.context.FacesContext, String) on the wrapped Application + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2350 + + ResourceHandler + + jakarta.faces.application.ApplicationWrapper.getResourceHandler +
+
+
+ The default behavior of this method is to call Application#getResourceHandler on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2351 + + SearchExpressionHandler + + jakarta.faces.application.ApplicationWrapper.getSearchExpressionHandler +
+
+
+ Return the thread-safe singleton SearchExpressionHandler for this application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2352 + + SearchKeywordResolver + + jakarta.faces.application.ApplicationWrapper.getSearchKeywordResolver +
+
+
+ Return the singleton SearchKeywordResolver instance to be used for all search keyword + resolution. This is actually an instance of a composite SearchKeywordResolver that must contain the + following SearchKeywordResolver instances in the following order: SearchKeywordResolver instances + declared using the element in the application configuration resources. Any SearchKeywordResolver + instances added by calls to #addSearchKeywordResolver. The SearchKeywordResolver implementations for + @all, @child(n), @form, @id(...), @namingcontainer, @next, @none, @parent, @previous, @root and + @this. The default implementation throws UnsupportedOperationException and is provided for the sole + purpose of not breaking existing applications that extend Application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2353 + + StateManager + + jakarta.faces.application.ApplicationWrapper.getStateManager +
+
+
+ The default behavior of this method is to call Application#getStateManager on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2354 + + Iterator + + jakarta.faces.application.ApplicationWrapper.getSupportedLocales +
+
+
+ The default behavior of this method is to call Application#getSupportedLocales on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2355 + + Iterator + + jakarta.faces.application.ApplicationWrapper.getValidatorIds +
+
+
+ The default behavior of this method is to call Application#getValidatorIds on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2356 + + ViewHandler + + jakarta.faces.application.ApplicationWrapper.getViewHandler +
+
+
+ The default behavior of this method is to call Application#getViewHandler on the + wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2357 + + Application + + jakarta.faces.application.ApplicationWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2358 + + void + + jakarta.faces.application.ApplicationWrapper.publishEvent +
+ ( + FacesContext + , +
+ Class + , +
+ Object + ) +
+
+ The default behavior of this method is to call + Application#publishEvent(jakarta.faces.context.FacesContext, Class, Object) on the wrapped + Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2359 + + void + + jakarta.faces.application.ApplicationWrapper.publishEvent +
+ ( + FacesContext + , +
+ Class + , +
+ Class + , +
+ Object + ) +
+
+ The default behavior of this method is to call + Application#publishEvent(jakarta.faces.context.FacesContext, Class, Class, Object) on the wrapped + Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2360 + + void + + jakarta.faces.application.ApplicationWrapper.removeELContextListener +
+ ( + ELContextListener + ) +
+
+ The default behavior of this method is to call + Application#removeELContextListener(jakarta.el.ELContextListener) on the wrapped Application object. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2361 + + void + + jakarta.faces.application.ApplicationWrapper.setActionListener +
+ ( + ActionListener + ) +
+
+ The default behavior of this method is to call + Application#setActionListener(jakarta.faces.event.ActionListener) on the wrapped Application object. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2362 + + void + + jakarta.faces.application.ApplicationWrapper.setDefaultLocale +
+ ( + Locale + ) +
+
+ The default behavior of this method is to call + Application#setDefaultLocale(java.util.Locale) on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2363 + + void + + jakarta.faces.application.ApplicationWrapper.setDefaultRenderKitId +
+ ( + String + ) +
+
+ The default behavior of this method is to call + Application#setDefaultRenderKitId(String) on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2364 + + void + + jakarta.faces.application.ApplicationWrapper.setFlowHandler +
+ ( + FlowHandler + ) +
+
+ Set the FlowHandler instance used by the NavigationHandler to satisfy the requirements + of the faces flows feature. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2365 + + void + + jakarta.faces.application.ApplicationWrapper.setMessageBundle +
+ ( + String + ) +
+
+ The default behavior of this method is to call Application#setMessageBundle(String) on + the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2366 + + void + + jakarta.faces.application.ApplicationWrapper.setNavigationHandler +
+ ( + NavigationHandler + ) +
+
+ The default behavior of this method is to call + Application#setNavigationHandler(NavigationHandler) on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2367 + + void + + jakarta.faces.application.ApplicationWrapper.setResourceHandler +
+ ( + ResourceHandler + ) +
+
+ The default behavior of this method is to call + Application#setResourceHandler(ResourceHandler) on the wrapped Application object. This method can + throw IllegalStateException and NullPointerException. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2368 + + void + + jakarta.faces.application.ApplicationWrapper.setSearchExpressionHandler +
+ ( + SearchExpressionHandler + ) +
+
+ Set the SearchExpressionHandler instance used by the application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2369 + + void + + jakarta.faces.application.ApplicationWrapper.setStateManager +
+ ( + StateManager + ) +
+
+ The default behavior of this method is to call + Application#setStateManager(StateManager) on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2370 + + void + + jakarta.faces.application.ApplicationWrapper.setSupportedLocales +
+ ( + Collection + ) +
+
+ The default behavior of this method is to call + Application#setSupportedLocales(java.util.Collection) on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2371 + + void + + jakarta.faces.application.ApplicationWrapper.setViewHandler +
+ ( + ViewHandler + ) +
+
+ The default behavior of this method is to call Application#setViewHandler(ViewHandler) + on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2372 + + void + + jakarta.faces.application.ApplicationWrapper.subscribeToEvent +
+ ( + Class + , +
+ Class + , +
+ SystemEventListener + ) +
+
+ The default behavior of this method is to call Application#subscribeToEvent(Class, + Class, jakarta.faces.event.SystemEventListener) on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2373 + + void + + jakarta.faces.application.ApplicationWrapper.subscribeToEvent +
+ ( + Class + , +
+ SystemEventListener + ) +
+
+ The default behavior of this method is to call Application#subscribeToEvent(Class, + jakarta.faces.event.SystemEventListener) on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2374 + + void + + jakarta.faces.application.ApplicationWrapper.unsubscribeFromEvent +
+ ( + Class + , +
+ Class + , +
+ SystemEventListener + ) +
+
+ The default behavior of this method is to call Application#unsubscribeFromEvent(Class, + Class, jakarta.faces.event.SystemEventListener) on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2375 + + void + + jakarta.faces.application.ApplicationWrapper.unsubscribeFromEvent +
+ ( + Class + , +
+ SystemEventListener + ) +
+
+ The default behavior of this method is to call Application#unsubscribeFromEvent(Class, + jakarta.faces.event.SystemEventListener) on the wrapped Application object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2376 + + ConfigurableNavigationHandler + + jakarta.faces.application.ConfigurableNavigationHandler.ConfigurableNavigationHandler +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2377 + + NavigationCase + + jakarta.faces.application.ConfigurableNavigationHandler.getNavigationCase +
+ ( + FacesContext + , +
+ String + , +
+ String + ) +
+
+ Return the NavigationCase representing the navigation that would be taken had + NavigationHandler#handleNavigation been called with the same arguments or null if there is no such + case. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2378 + + NavigationCase + + jakarta.faces.application.ConfigurableNavigationHandler.getNavigationCase +
+ ( + FacesContext + , +
+ String + , +
+ String + , +
+ String + ) +
+
+ Return the NavigationCase representing the navigation that would be taken had + NavigationHandler#handleNavigation been called with the same arguments or null if there is no such + case. Implementations that comply the version of the specification in which this method was + introduced must override this method. For compatibility with decorated implementations that comply + with an earlier version of the specification, an implementation is provided that simply calls + through to #getNavigationCase(jakarta.faces.context.FacesContext, java.lang.String, + java.lang.String), ignoring the toFlowDocumentId parameter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2379 + + Map + + jakarta.faces.application.ConfigurableNavigationHandler.getNavigationCases +
+
+
+ Return a Map where the keys are values and the values are Set where each element in the + Set is a NavigationCase that applies to that . The implementation must support live modifications to + this Map. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2380 + + void + + jakarta.faces.application.ConfigurableNavigationHandler.inspectFlow +
+ ( + FacesContext + , +
+ Flow + ) +
+
+ Called by the flow system to cause the flow to be inspected for navigation rules. For + backward compatibility with earlier implementations, an empty method is provided. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2381 + + void + + jakarta.faces.application.ConfigurableNavigationHandler.performNavigation +
+ ( + String + ) +
+
+ A convenience method to signal the Jakarta Faces implementation to perform navigation + with the provided outcome. When the NavigationHandler is invoked, the current viewId is treated as + the "from viewId" and the "from action" is null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2382 + + ConfigurableNavigationHandlerWrapper + + + jakarta.faces.application.ConfigurableNavigationHandlerWrapper.ConfigurableNavigationHandlerWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:2383 + + ConfigurableNavigationHandlerWrapper + + + jakarta.faces.application.ConfigurableNavigationHandlerWrapper.ConfigurableNavigationHandlerWrapper +
+ ( + ConfigurableNavigationHandler + ) +
+
+ If this configurable navigation handler has been decorated, the implementation doing + the decorating should push the implementation being wrapped to this constructor. The #getWrapped() + will then return the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2384 + + NavigationCase + + jakarta.faces.application.ConfigurableNavigationHandlerWrapper.getNavigationCase +
+ ( + FacesContext + , +
+ String + , +
+ String + ) +
+
+ Return the NavigationCase representing the navigation that would be taken had + NavigationHandler#handleNavigation been called with the same arguments or null if there is no such + case. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2385 + + NavigationCase + + jakarta.faces.application.ConfigurableNavigationHandlerWrapper.getNavigationCase +
+ ( + FacesContext + , +
+ String + , +
+ String + , +
+ String + ) +
+
+ Return the NavigationCase representing the navigation that would be taken had + NavigationHandler#handleNavigation been called with the same arguments or null if there is no such + case. Implementations that comply the version of the specification in which this method was + introduced must override this method. For compatibility with decorated implementations that comply + with an earlier version of the specification, an implementation is provided that simply calls + through to #getNavigationCase(jakarta.faces.context.FacesContext, java.lang.String, + java.lang.String), ignoring the toFlowDocumentId parameter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2386 + + Map + + jakarta.faces.application.ConfigurableNavigationHandlerWrapper.getNavigationCases +
+
+
+ Return a Map where the keys are values and the values are Set where each element in the + Set is a NavigationCase that applies to that . The implementation must support live modifications to + this Map. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2387 + + ConfigurableNavigationHandler + + jakarta.faces.application.ConfigurableNavigationHandlerWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2388 + + void + + jakarta.faces.application.ConfigurableNavigationHandlerWrapper.handleNavigation +
+ ( + FacesContext + , +
+ String + , +
+ String + ) +
+
+ Perform navigation processing based on the state information in the specified + FacesContext, plus the outcome string returned by an executed application action. If the + implementation class also extends ConfigurableNavigationHandler, the implementation must guarantee + that the logic used in a call to ConfigurableNavigationHandler#getNavigationCase is used in this + method to determine the correct navigation. This method must set the render targets (used in partial + rendering) to render all invoking jakarta.faces.context.PartialViewContext#setRenderAll) if the view + identifier has changed as the result of an application action (to take into account Ajax requests). + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2389 + + void + + jakarta.faces.application.ConfigurableNavigationHandlerWrapper.inspectFlow +
+ ( + FacesContext + , +
+ Flow + ) +
+
+ Called by the flow system to cause the flow to be inspected for navigation rules. For + backward compatibility with earlier implementations, an empty method is provided. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2390 + + void + + jakarta.faces.application.ConfigurableNavigationHandlerWrapper.performNavigation +
+ ( + String + ) +
+
+ A convenience method to signal the Jakarta Faces implementation to perform navigation + with the provided outcome. When the NavigationHandler is invoked, the current viewId is treated as + the "from viewId" and the "from action" is null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2391 + + FacesMessage + + jakarta.faces.application.FacesMessage.FacesMessage +
+
+
+ Construct a new jakarta.faces.application.FacesMessage with no initial values. The + severity is set to Severity.INFO. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2392 + + FacesMessage + + jakarta.faces.application.FacesMessage.FacesMessage +
+ ( + String + ) +
+
+ Construct a new jakarta.faces.application.FacesMessage with just a summary. The detail + is null, the severity is set to Severity.INFO. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2393 + + FacesMessage + + jakarta.faces.application.FacesMessage.FacesMessage +
+ ( + String + , +
+ String + ) +
+
+ Construct a new jakarta.faces.application.FacesMessage with the specified initial + values. The severity is set to Severity.INFO. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2394 + + FacesMessage + + jakarta.faces.application.FacesMessage.FacesMessage +
+ ( + Severity + , +
+ String + , +
+ String + ) +
+
+ Construct a new FacesMessage with the specified initial values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2395 + + String + + jakarta.faces.application.FacesMessage.getDetail +
+
+
+ Return the localized detail text. If no localized detail text has been defined for this + message, return the localized summary text instead. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2396 + + Severity + + jakarta.faces.application.FacesMessage.getSeverity +
+
+
+ Return the severity level. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2397 + + String + + jakarta.faces.application.FacesMessage.getSummary +
+
+
+ Return the localized summary text. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2398 + + boolean + + jakarta.faces.application.FacesMessage.isRendered +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2399 + + void + + jakarta.faces.application.FacesMessage.rendered +
+
+
+ Marks this message as having been rendered to the client. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2400 + + void + + jakarta.faces.application.FacesMessage.setDetail +
+ ( + String + ) +
+
+ Set the localized detail text. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2401 + + void + + jakarta.faces.application.FacesMessage.setSeverity +
+ ( + Severity + ) +
+
+ Set the severity level. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2402 + + void + + jakarta.faces.application.FacesMessage.setSummary +
+ ( + String + ) +
+
+ Set the localized summary text. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2403 + + int + + jakarta.faces.application.FacesMessage.Severity.compareTo +
+ ( + Object + ) +
+
+ Compare this jakarta.faces.application.FacesMessage.Severity instance to the specified + one. Returns a negative integer, zero, or a positive integer if this object is less than, equal to, + or greater than the specified object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2404 + + int + + jakarta.faces.application.FacesMessage.Severity.getOrdinal +
+
+
+ Return the ordinal value of this FacesMessage.Severity instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2405 + + String + + jakarta.faces.application.FacesMessage.Severity.toString +
+
+
+ Return a String representation of this FacesMessage.Severity instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2406 + + boolean + + jakarta.faces.application.NavigationCase.equals +
+ ( + Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2407 + + URL + + jakarta.faces.application.NavigationCase.getActionURL +
+ ( + FacesContext + ) +
+
+ Construct an absolute URL to this NavigationCase instance using + jakarta.faces.application.ViewHandler#getActionURL on the path portion of the url. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2408 + + URL + + jakarta.faces.application.NavigationCase.getActionURL +
+ ( + FacesContext + ) + +
+ throws + MalformedURLException +
+
+
+ if the process of constructing the URL causes this exception to be thrown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2409 + + URL + + jakarta.faces.application.NavigationCase.getBookmarkableURL +
+ ( + FacesContext + ) +
+
+ Construct an absolute URL suitable for a bookmarkable link to this NavigationCase + instance using jakarta.faces.application.ViewHandler#getBookmarkableURL on the path portion of the + url. This URL may include view parameters specified as metadata within the view. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2410 + + URL + + jakarta.faces.application.NavigationCase.getBookmarkableURL +
+ ( + FacesContext + ) + +
+ throws + MalformedURLException +
+
+
+ if the process of constructing the URL causes this exception to be thrown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2411 + + Boolean + + jakarta.faces.application.NavigationCase.getCondition +
+ ( + FacesContext + ) +
+
+ Evaluates the for this , if any. The expression to be evaluated is passed into the + constructor as a string. When the expression is evaluated, its value must be coerced into a boolean + per the normal Jakarta Expression Language coercion rules. Note throws any exceptions encountered + during the process of evaluating the expression or obtaining its value. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2412 + + String + + jakarta.faces.application.NavigationCase.getFromAction +
+
+
+ Return the for this + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2413 + + String + + jakarta.faces.application.NavigationCase.getFromOutcome +
+
+
+ Return the for this + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2414 + + String + + jakarta.faces.application.NavigationCase.getFromViewId +
+
+
+ Return the of the inside which this is nested. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2415 + + Map + + jakarta.faces.application.NavigationCase.getParameters +
+
+
+ Return the parameters to be included for navigation cases requiring a redirect. If no + parameters are defined, null will be returned. The keys in the Map are parameter names. For each + key, the corresponding value is a List of unconverted values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2416 + + URL + + jakarta.faces.application.NavigationCase.getRedirectURL +
+ ( + FacesContext + ) +
+
+ Construct an absolute URL suitable for a "redirect" to this NavigationCase instance + using jakarta.faces.application.ViewHandler#getRedirectURL on the path portion of the url. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2417 + + URL + + jakarta.faces.application.NavigationCase.getRedirectURL +
+ ( + FacesContext + ) + +
+ throws + MalformedURLException +
+
+
+ if the process of constructing the URL causes this exception to be thrown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2418 + + URL + + jakarta.faces.application.NavigationCase.getResourceURL +
+ ( + FacesContext + ) +
+
+ Construct an absolute URL to this NavigationCase instance using + jakarta.faces.application.ViewHandler#getResourceURL on the path portion of the url. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2419 + + URL + + jakarta.faces.application.NavigationCase.getResourceURL +
+ ( + FacesContext + ) + +
+ throws + MalformedURLException +
+
+
+ if the process of constructing the URL causes this exception to be thrown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2420 + + String + + jakarta.faces.application.NavigationCase.getToFlowDocumentId +
+
+
+ If this navigation case represents a flow invocation, this property is the documentId + in which the flow whose id is given by the return from #getFromOutcome() is defined. Implementations + must override this method to return the value defined in the corresponding application configuration + resources element. The base implementation returns the empty string. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2421 + + String + + jakarta.faces.application.NavigationCase.getToViewId +
+ ( + FacesContext + ) +
+
+ Evaluates the for this + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2422 + + boolean + + jakarta.faces.application.NavigationCase.hasCondition +
+
+
+ Test if this navigation case has an associated element. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2423 + + int + + jakarta.faces.application.NavigationCase.hashCode +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2424 + + boolean + + jakarta.faces.application.NavigationCase.isIncludeViewParams +
+
+
+ Return the value for this . This will be true if the view parametets should be encoded + into the redirect URL (only applies to redirect case) + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2425 + + boolean + + jakarta.faces.application.NavigationCase.isRedirect +
+
+
+ Return the value for this . This will be true if the new view should be navigated to + via a jakarta.faces.context.ExternalContext#redirect(String) + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2426 + + NavigationCase + + jakarta.faces.application.NavigationCase.NavigationCase +
+ ( + String + , +
+ String + , +
+ String + , +
+ String + , +
+ String + , +
+ Map + , +
+ boolean + , +
+ boolean + ) +
+
+ Construct a new NavigationCase based on the provided arguments. See section 7.4.2 + "Default NavigationHandler Algorithm" of the Jakarta Faces Specification Document for how a + NavigationCase is used by the standard ConfigurableNavigationHandler + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2427 + + NavigationCase + + jakarta.faces.application.NavigationCase.NavigationCase +
+ ( + String + , +
+ String + , +
+ String + , +
+ String + , +
+ String + , +
+ String + , +
+ Map + , +
+ boolean + , +
+ boolean + ) +
+
+ Construct a new NavigationCase based on the provided arguments. See section 7.4.2 + "Default NavigationHandler Algorithm" of the Jakarta Faces Specification Document for how a + NavigationCase is used by the standard ConfigurableNavigationHandler + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2428 + + String + + jakarta.faces.application.NavigationCase.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2429 + + boolean + + jakarta.faces.application.NavigationCaseWrapper.equals +
+ ( + Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2430 + + URL + + jakarta.faces.application.NavigationCaseWrapper.getActionURL +
+ ( + FacesContext + ) +
+
+ Construct an absolute URL to this NavigationCase instance using + jakarta.faces.application.ViewHandler#getActionURL on the path portion of the url. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2431 + + URL + + jakarta.faces.application.NavigationCaseWrapper.getActionURL +
+ ( + FacesContext + ) + +
+ throws + MalformedURLException +
+
+
+ if the process of constructing the URL causes this exception to be thrown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2432 + + URL + + jakarta.faces.application.NavigationCaseWrapper.getBookmarkableURL +
+ ( + FacesContext + ) +
+
+ Construct an absolute URL suitable for a bookmarkable link to this NavigationCase + instance using jakarta.faces.application.ViewHandler#getBookmarkableURL on the path portion of the + url. This URL may include view parameters specified as metadata within the view. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2433 + + URL + + jakarta.faces.application.NavigationCaseWrapper.getBookmarkableURL +
+ ( + FacesContext + ) + +
+ throws + MalformedURLException +
+
+
+ if the process of constructing the URL causes this exception to be thrown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2434 + + Boolean + + jakarta.faces.application.NavigationCaseWrapper.getCondition +
+ ( + FacesContext + ) +
+
+ Evaluates the for this , if any. The expression to be evaluated is passed into the + constructor as a string. When the expression is evaluated, its value must be coerced into a boolean + per the normal Jakarta Expression Language coercion rules. Note throws any exceptions encountered + during the process of evaluating the expression or obtaining its value. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2435 + + String + + jakarta.faces.application.NavigationCaseWrapper.getFromAction +
+
+
+ Return the for this + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2436 + + String + + jakarta.faces.application.NavigationCaseWrapper.getFromOutcome +
+
+
+ Return the for this + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2437 + + String + + jakarta.faces.application.NavigationCaseWrapper.getFromViewId +
+
+
+ Return the of the inside which this is nested. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2438 + + Map + + jakarta.faces.application.NavigationCaseWrapper.getParameters +
+
+
+ Return the parameters to be included for navigation cases requiring a redirect. If no + parameters are defined, null will be returned. The keys in the Map are parameter names. For each + key, the corresponding value is a List of unconverted values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2439 + + URL + + jakarta.faces.application.NavigationCaseWrapper.getRedirectURL +
+ ( + FacesContext + ) +
+
+ Construct an absolute URL suitable for a "redirect" to this NavigationCase instance + using jakarta.faces.application.ViewHandler#getRedirectURL on the path portion of the url. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2440 + + URL + + jakarta.faces.application.NavigationCaseWrapper.getRedirectURL +
+ ( + FacesContext + ) + +
+ throws + MalformedURLException +
+
+
+ if the process of constructing the URL causes this exception to be thrown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2441 + + URL + + jakarta.faces.application.NavigationCaseWrapper.getResourceURL +
+ ( + FacesContext + ) +
+
+ Construct an absolute URL to this NavigationCase instance using + jakarta.faces.application.ViewHandler#getResourceURL on the path portion of the url. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2442 + + URL + + jakarta.faces.application.NavigationCaseWrapper.getResourceURL +
+ ( + FacesContext + ) + +
+ throws + MalformedURLException +
+
+
+ if the process of constructing the URL causes this exception to be thrown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2443 + + String + + jakarta.faces.application.NavigationCaseWrapper.getToFlowDocumentId +
+
+
+ If this navigation case represents a flow invocation, this property is the documentId + in which the flow whose id is given by the return from #getFromOutcome() is defined. Implementations + must override this method to return the value defined in the corresponding application configuration + resources element. The base implementation returns the empty string. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2444 + + String + + jakarta.faces.application.NavigationCaseWrapper.getToViewId +
+ ( + FacesContext + ) +
+
+ Evaluates the for this + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2445 + + NavigationCase + + jakarta.faces.application.NavigationCaseWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2446 + + boolean + + jakarta.faces.application.NavigationCaseWrapper.hasCondition +
+
+
+ Test if this navigation case has an associated element. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2447 + + int + + jakarta.faces.application.NavigationCaseWrapper.hashCode +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2448 + + boolean + + jakarta.faces.application.NavigationCaseWrapper.isIncludeViewParams +
+
+
+ Return the value for this . This will be true if the view parametets should be encoded + into the redirect URL (only applies to redirect case) + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2449 + + boolean + + jakarta.faces.application.NavigationCaseWrapper.isRedirect +
+
+
+ Return the value for this . This will be true if the new view should be navigated to + via a jakarta.faces.context.ExternalContext#redirect(String) + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2450 + + NavigationCaseWrapper + + jakarta.faces.application.NavigationCaseWrapper.NavigationCaseWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:2451 + + NavigationCaseWrapper + + jakarta.faces.application.NavigationCaseWrapper.NavigationCaseWrapper +
+ ( + NavigationCase + ) +
+
+ If this navigation case has been decorated, the implementation doing the decorating + should push the implementation being wrapped to this constructor. The #getWrapped() will then return + the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2452 + + String + + jakarta.faces.application.NavigationCaseWrapper.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2453 + + void + + jakarta.faces.application.NavigationHandler.handleNavigation +
+ ( + FacesContext + , +
+ String + , +
+ String + ) +
+
+ Perform navigation processing based on the state information in the specified + FacesContext, plus the outcome string returned by an executed application action. If the + implementation class also extends ConfigurableNavigationHandler, the implementation must guarantee + that the logic used in a call to ConfigurableNavigationHandler#getNavigationCase is used in this + method to determine the correct navigation. This method must set the render targets (used in partial + rendering) to render all invoking jakarta.faces.context.PartialViewContext#setRenderAll) if the view + identifier has changed as the result of an application action (to take into account Ajax requests). + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2454 + + void + + jakarta.faces.application.NavigationHandler.handleNavigation +
+ ( + FacesContext + , +
+ String + , +
+ String + , +
+ String + ) +
+
+ Overloaded variant of #handleNavigation(jakarta.faces.context.FacesContext, + java.lang.String, java.lang.String) that allows the caller to provide the defining document id for a + flow to be entered by this navigation. For backward compatibility with decorated NavigationHandler + implementations that conform to an earlier version of the specification, an implementation is + provided that calls through to #handleNavigation(jakarta.faces.context.FacesContext, + java.lang.String, java.lang.String), ignoring the toFlowDocumentId parameter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2455 + + NavigationHandler + + jakarta.faces.application.NavigationHandlerWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2456 + + void + + jakarta.faces.application.NavigationHandlerWrapper.handleNavigation +
+ ( + FacesContext + , +
+ String + , +
+ String + ) +
+
+ Perform navigation processing based on the state information in the specified + FacesContext, plus the outcome string returned by an executed application action. If the + implementation class also extends ConfigurableNavigationHandler, the implementation must guarantee + that the logic used in a call to ConfigurableNavigationHandler#getNavigationCase is used in this + method to determine the correct navigation. This method must set the render targets (used in partial + rendering) to render all invoking jakarta.faces.context.PartialViewContext#setRenderAll) if the view + identifier has changed as the result of an application action (to take into account Ajax requests). + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2457 + + void + + jakarta.faces.application.NavigationHandlerWrapper.handleNavigation +
+ ( + FacesContext + , +
+ String + , +
+ String + , +
+ String + ) +
+
+ Overloaded variant of #handleNavigation(jakarta.faces.context.FacesContext, + java.lang.String, java.lang.String) that allows the caller to provide the defining document id for a + flow to be entered by this navigation. For backward compatibility with decorated NavigationHandler + implementations that conform to an earlier version of the specification, an implementation is + provided that calls through to #handleNavigation(jakarta.faces.context.FacesContext, + java.lang.String, java.lang.String), ignoring the toFlowDocumentId parameter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2458 + + NavigationHandlerWrapper + + jakarta.faces.application.NavigationHandlerWrapper.NavigationHandlerWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:2459 + + NavigationHandlerWrapper + + jakarta.faces.application.NavigationHandlerWrapper.NavigationHandlerWrapper +
+ ( + NavigationHandler + ) +
+
+ If this navigation handler has been decorated, the implementation doing the decorating + should push the implementation being wrapped to this constructor. The #getWrapped() will then return + the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2460 + + ProjectStage + + jakarta.faces.application.ProjectStage.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2461 + + ProjectStage[] + + jakarta.faces.application.ProjectStage.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2462 + + ProtectedViewException + + jakarta.faces.application.ProtectedViewException.ProtectedViewException +
+
+
+ Construct a new exception with no detail message or root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2463 + + ProtectedViewException + + jakarta.faces.application.ProtectedViewException.ProtectedViewException +
+ ( + String + ) +
+
+ Construct a new exception with the specified detail message and no root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2464 + + ProtectedViewException + + jakarta.faces.application.ProtectedViewException.ProtectedViewException +
+ ( + Throwable + ) +
+
+ Construct a new exception with the specified root cause. The detail message will be set + to (cause == null ? null : cause.toString() + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2465 + + ProtectedViewException + + jakarta.faces.application.ProtectedViewException.ProtectedViewException +
+ ( + String + , +
+ Throwable + ) +
+
+ Construct a new exception with the specified detail message and root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2466 + + String + + jakarta.faces.application.Resource.getContentType +
+
+
+ Return the MIME content-type for this resource. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2467 + + InputStream + + jakarta.faces.application.Resource.getInputStream +
+
+
+ If the current request is a resource request, (that is, + ResourceHandler#isResourceRequest returns true), return an InputStream containing the bytes of the + resource. Otherwise, throw an IOException. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2468 + + InputStream + + jakarta.faces.application.Resource.getInputStream +
+
+ throws + IOException +
+
+
+ if the current request is not a resource request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2469 + + String + + jakarta.faces.application.Resource.getLibraryName +
+
+
+ Return the libraryName for this resource. May be null. The libraryName for a resource + is an optional String that indicates membership in a "resource library". All resources with the same + libraryName belong to the same "resource library". The "resource library" concept allows + disambiguating resources that have the same resourceName. See ResourceHandler for more information. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2470 + + String + + jakarta.faces.application.Resource.getRequestPath +
+
+
+ Return a path to this resource such that, when the browser resolves it against the base + URI for the view that includes the resource, and issues a GET request to the resultant fully + qualified URL, the bytes of the resource are returned in response. The default implementation must + implement the following algorithm. For discussion, the return result from this method will be called + result. Get the context-root for this web application, not ending in slash. For discussion this will + be called contextRoot. Discover if the FacesServlet is prefix (path) mapped, extension mapped, or + exact mapped (as defined by Servlet.12.2.) and the value of the mapping (including the leading '.' + in the case of extension mapping). For discussion, this will be facesServletMapping. If exact + mapped, result must be the following if and only if the FacesServlet is mapped to the exact URL + pattern ResourceHandler#RESOURCE_IDENTIFIER + #getResourceName result = contextRoot + + ResourceHandler#RESOURCE_IDENTIFIER + #getResourceName If exact mapped, and the FacesServlet is not + mapped to the exact URL pattern ResourceHandler#RESOURCE_IDENTIFIER + #getResourceName do the + following: Retrieve the existing mappings of the FacesServlet, e.g. using + ServletRegistration#getMappings(), and from those pick any prefix mapping or extension mapping. If + no such mapping is found, throw an IllegalStateException. If such mapping is found remove the * + character from that mapping, take that as the new facesServletMapping and continue with evaluating + this mapping as specified below for if prefix mapped and for if extension mapped If prefix mapped, + result must be result = contextRoot + '/' + facesServletMapping + + ResourceHandler#RESOURCE_IDENTIFIER + '/' + #getResourceName If extension mapped, result must be + result = contextRoot + ResourceHandler#RESOURCE_IDENTIFIER + #getResourceName + facesServletMapping + Build up a string, called resourceMetaData which is an amp; separated string of name=value pairs + suitable for inclusion in a URL query string. If #getLibraryName returns non-null, resourceMetaData + must include "ln=" + the return from #getLibraryName If there is a localePrefix for this + application, as defined in ResourceHandler#LOCALE_PREFIX, resourceMetaData must include "loc=" + the + localePrefix. If this resource is contained in a resource library contract, resourceMetaData must + include "con=" + the name of the resource library contract. Append "?" + resourceMetaData to result. + Make it portlet safe by passing the result through ViewHandler#getResourceURL. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2471 + + String + + jakarta.faces.application.Resource.getResourceName +
+
+
+ Return the resourceName for this resource. Will never be null. All Resource instances + must have a resourceName. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2472 + + Map + + jakarta.faces.application.Resource.getResponseHeaders +
+
+
+ Returns a mutable Map whose entries will be sent as response headers during + ResourceHandler#handleResourceRequest. The entries in this map must not persist beyond the scope of + a single request. Any modifications made to the map after the resource has been served will be + ignored by the run-time. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2473 + + URL + + jakarta.faces.application.Resource.getURL +
+
+
+ Return an actual URL instance that refers to this resource instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2474 + + Resource + + jakarta.faces.application.Resource.Resource +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2475 + + void + + jakarta.faces.application.Resource.setContentType +
+ ( + String + ) +
+
+ Set the MIME content-type for this resource. The default implementation performs no + validation on the argument. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2476 + + void + + jakarta.faces.application.Resource.setLibraryName +
+ ( + String + ) +
+
+ Set the libraryName for this resource. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2477 + + void + + jakarta.faces.application.Resource.setResourceName +
+ ( + String + ) +
+
+ Set the resourceName for this resource. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2478 + + String + + jakarta.faces.application.Resource.toString +
+
+
+ Call through to #getRequestPath and return the result. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2479 + + boolean + + jakarta.faces.application.Resource.userAgentNeedsUpdate +
+ ( + FacesContext + ) +
+
+ Return true if the user-agent requesting this resource needs an update. If the + If-Modified-Since HTTP header is available for this request, its value must be consulted, as + specified in Section 14.25 of IETF RFC 2616, to determine the result. Returns false if the + user-agent does not need an update for this resource. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2480 + + ResourceDependency[] + + jakarta.faces.application.ResourceDependencies.value +
+
+
+ The individual resource dependencies + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2481 + + String + + jakarta.faces.application.ResourceDependency.library +
+
+
+ The libraryName in which the resource pointed to by this ResourceDependency resides. If + not specified, defaults to the empty string. It is valid to have Jakarta Expression Language + Expressions in the value of this attribute, as long as the expression resolves to an instance of the + expected type. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2482 + + String + + jakarta.faces.application.ResourceDependency.name +
+
+
+ The resourceName of the resource pointed to by this ResourceDependency. It is valid to + have Jakarta Expression Language Expressions in the value of this attribute, as long as the + expression resolves to an instance of the expected type. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2483 + + String + + jakarta.faces.application.ResourceDependency.target +
+
+
+ The value given for this attribute will be passed as the "target" argument to + jakarta.faces.component.UIViewRoot#addComponentResource(jakarta.faces.context.FacesContext, + jakarta.faces.component.UIComponent, java.lang.String). If this attribute is specified, + jakarta.faces.component.UIViewRoot#addComponentResource(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent) + must be called instead, as described above. It is valid to have Jakarta Expression Language + Expressions in the value of this attribute, as long as the expression resolves to an instance of the + expected type. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2484 + + Resource + + jakarta.faces.application.ResourceHandler.createResource +
+ ( + String + ) +
+
+ Create an instance of ViewResource given the argument resourceName. The content-type of + the resource is derived by passing the resourceName to + jakarta.faces.context.ExternalContext#getMimeType The algorithm specified in section 2.6.1.4 + "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document must be + executed to create the Resource. New requirements were introduced in version 2.2 of the + specification. For historical reasons, this method operate correctly when the argument resourceName + is of the form libraryName/resourceName, even when resourceName contains '/' characters. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2485 + + Resource + + jakarta.faces.application.ResourceHandler.createResource +
+ ( + String + , +
+ String + ) +
+
+ Create an instance of Resource with a resourceName given by the value of the argument + resourceName that is a member of the library named by the argument libraryName. The content-type of + the resource is derived by passing the resourceName to + jakarta.faces.context.ExternalContext#getMimeType. The algorithm specified in section 2.6.1.4 + "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document must be + executed to create the Resource. New requirements were introduced in version 2.2 of the + specification. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2486 + + Resource + + jakarta.faces.application.ResourceHandler.createResource +
+ ( + String + , +
+ String + , +
+ String + ) +
+
+ Create an instance of Resource with a resourceName given by the value of the argument + resourceName that is a member of the library named by the argument libraryName that claims to have + the content-type given by the argument content-type. The algorithm specified in section 2.6.1.4 + "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document must be + executed to create the Resource. New requirements were introduced in version 2.2 of the + specification. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2487 + + Resource + + jakarta.faces.application.ResourceHandler.createResourceFromId +
+ ( + String + ) +
+
+ Create an instance of Resource given the argument resourceId. The content-type of the + resource is derived by passing the resourceName to jakarta.faces.context.ExternalContext#getMimeType + The resource must be identified according to the specification in section 2.6.1.3 "Resource + Identifiers" of the Jakarta Faces Specification Document. New requirements were introduced in + version 2.2 of the specification. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2488 + + ViewResource + + jakarta.faces.application.ResourceHandler.createViewResource +
+ ( + FacesContext + , +
+ String + ) +
+
+ Create an instance of Resource given the argument resourceName, which may contain "/" + characters. The jakarta.faces.view.ViewDeclarationLanguage calls this method when it needs to load a + view from a persistent store, such as a filesystem. This method is functionality equivalent to + #createResource(java.lang.String), but all callsites that need to load VDL views must use this + method so that classes that want to decorate the ResourceHandler in order to only affect the loading + of views may do so without affecting the processing of other kinds of resources, such as scripts and + stylesheets. A jakarta.faces.context.FacesContext must be present before calling this method. To + preserve compatibility with prior revisions of the specification, a default implementation must be + provided that calls #createResource(java.lang.String). The default implementation must look for the + resource in the following places, in this order. Considering resource library contracts (at the + locations specified in the Jakarta Faces Specification Document section 2.7 "Resource Library + Contracts"). Considering the web app root. Considering faces flows (at the locations specified in + the Jakarta Faces Specification Document section 11.3.3 "Faces Flows"). Call + FacesContext#getResourceLibraryContracts. If the result is non-null and not empty, for each value in + the list, treat the value as the name of a resource library contract. If the argument resoureName + exists as a resource in the resource library contract, return it. Otherwise, return the resource + (not in the resource library contract), if found. Otherwise, return null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2489 + + String + + jakarta.faces.application.ResourceHandler.getRendererTypeForResourceName +
+ ( + String + ) +
+
+ Return the renderer-type for a jakarta.faces.render.Renderer that is capable of + rendering this resource. The default implementation must return values according to the following + table. If no renderer-type can be determined, null must be returned. resource name to renderer-type + mapping example resource name renderer-type mycomponent.js jakarta.faces.resource.Script mystyle.css + jakarta.faces.resource.Stylesheet + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2490 + + Stream + + jakarta.faces.application.ResourceHandler.getViewResources +
+ ( + FacesContext + , +
+ String + , +
+ int + , +
+ ResourceVisitOption[] + ) +
+
+ Return a Stream possibly lazily populated by walking the resource tree rooted at a + given initial path. The resource tree is traversed breadth-first, the elements in the stream are + view resource names that would yield a ViewResource when passed into + ResourceHandler#createViewResource as the resourceName parameter. The maxDepth parameter is the + maximum depth of directory levels to visit beyond the initial path, which is always visited. The + value is relative to the root (/), not to the given initial path. E.g. given maxDepth = 3 and + initial path /foo/, visiting will proceed up to /foo/bar/, where / counts as depth 1, /foo/ as depth + 2 and /foo/bar/ as depth 3. A value lower or equal to the depth of the initial path means that only + the initial path is visited. A value of Integer#MAX_VALUE MAX_VALUE may be used to indicate that all + levels should be visited. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2491 + + Stream + + jakarta.faces.application.ResourceHandler.getViewResources +
+ ( + FacesContext + , +
+ String + , +
+ ResourceVisitOption[] + ) +
+
+ Return a Stream possibly lazily populated by walking the resource tree rooted at a + given initial path. The resource tree is traversed breadth-first, the elements in the stream are + view resource names that would yield a ViewResource when passed into + ResourceHandler#createViewResource as the resourceName parameter. This method works as if invoking + it were equivalent to evaluating the expression: getViewResources(facesContext, start, + Integer.MAX_VALUE, options) Put differently, it visits all levels of the resource tree. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2492 + + void + + jakarta.faces.application.ResourceHandler.handleResourceRequest +
+ ( + FacesContext + ) +
+
+ This method specifies the contract for satisfying resource requests. This method is + called from jakarta.faces.webapp.FacesServlet#service after that method determines the current + request is a resource request by calling #isResourceRequest. Thus, handleResourceRequest may assume + that the current request is a resource request. The default implementation must implement an + algorithm semantically identical to the following algorithm. For discussion, in all cases when a + status code is to be set, this spec talks only using the Jakarta Servlet API, but it is understood + that in a portlet environment the appropriate equivalent API must be used. If the resourceIdentifier + ends with any of the extensions listed in the value of the #RESOURCE_EXCLUDES_PARAM_NAME init + parameter, HttpServletRequest.SC_NOT_FOUND must be passed to HttpServletResponse.setStatus(), then + handleResourceRequest must immediately return. Extract the resourceName from the resourceIdentifier + by taking the substring of resourceIdentifier that starts at #RESOURCE_IDENTIFIER.length() + 1 and + goes to the end of resourceIdentifier. If no resourceName can be extracted, + HttpServletRequest.SC_NOT_FOUND must be passed to HttpServletResponse.setStatus(), then + handleResourceRequest must immediately return. Extract the libraryName from the request by looking + in the request parameter map for an entry under the key "ln", without the quotes. If found, use its + value as the libraryName. If resourceName and libraryName are present, call #createResource(String, + String) to create the Resource. If only resourceName is present, call #createResource(String) to + create the Resource. If the Resource cannot be successfully created, HttpServletRequest.SC_NOT_FOUND + must be passed to HttpServletResponse.setStatus(), then handleResourceRequest must immediately + return. Call Resource#userAgentNeedsUpdate. If this method returns false, + HttpServletRequest.SC_NOT_MODIFIED must be passed to HttpServletResponse.setStatus(), then + handleResourceRequest must immediately return. Pass the result of Resource#getContentType to + HttpServletResponse.setContentType. Call Resource#getResponseHeaders. For each entry in this Map, + call HttpServletResponse.setHeader(), passing the key as the first argument and the value as the + second argument. Call Resource#getInputStream and serve up the bytes of the resource to the + response. Call HttpServletResponse.setContentLength() passing the byte count of the resource. If an + IOException is thrown during any of the previous steps, log a descriptive, localized message, + including the resourceName and libraryName (if present). Then, HttpServletRequest.SC_NOT_FOUND must + be passed to HttpServletResponse.setStatus(), then handleResourceRequest must immediately return. In + all cases in this method, any streams, channels, sockets, or any other IO resources must be closed + before this method returns. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2493 + + void + + jakarta.faces.application.ResourceHandler.handleResourceRequest +
+ ( + FacesContext + ) + +
+ throws + IOException +
+
+
+ when an I/O error occurs. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2494 + + boolean + + jakarta.faces.application.ResourceHandler.isResourceRendered +
+ ( + FacesContext + , +
+ String + , +
+ String + ) +
+
+ Returns whether the resource as identified by given resource and library name has been + rendered. The default implementation must during the render response phase of the current view + return true when the resource has been marked as rendered via #markResourceRendered(FacesContext, + String, String). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2495 + + boolean + + jakarta.faces.application.ResourceHandler.isResourceRequest +
+ ( + FacesContext + ) +
+
+ Return true if the current request is a resource request. This method is called by + jakarta.faces.webapp.FacesServlet#service to determine if this request is a view request or a + resource request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2496 + + boolean + + jakarta.faces.application.ResourceHandler.isResourceURL +
+ ( + String + ) +
+
+ Return true if the argument url contains the string given by the value of the constant + ResourceHandler#RESOURCE_IDENTIFIER, false otherwise. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2497 + + boolean + + jakarta.faces.application.ResourceHandler.libraryExists +
+ ( + String + ) +
+
+ Return true if the resource library named by the argument libraryName can be found. If + there is a localePrefix for this application, as defined in #LOCALE_PREFIX, first look for the + library with the prefix. If no such library is found, look for the library without the prefix. This + allows developers to avoid duplication of files. For example, consider the case where the developer + wants to have a resource library containing a localized image resource and a non-localized script + resource. By checking both locations for the existence of the library, along with other spec changes + in section 2.6.1.4 "Libraries of Localized and Versioned Resources" of the Jakarta Faces + Specification Document, this scenario is enabled. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2498 + + void + + jakarta.faces.application.ResourceHandler.markResourceRendered +
+ ( + FacesContext + , +
+ String + , +
+ String + ) +
+
+ Mark the resource as identified by given resource and library name as rendered. The + default implementation must ensure that #isResourceRendered(FacesContext, String, String) will + return true when the resource has already been rendered during the render response phase of the + current view. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2499 + + ResourceHandler + + jakarta.faces.application.ResourceHandler.ResourceHandler +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2500 + + Resource + + jakarta.faces.application.ResourceHandlerWrapper.createResource +
+ ( + String + ) +
+
+ The default behavior of this method is to call ResourceHandler#createResource(String) + on the wrapped ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2501 + + Resource + + jakarta.faces.application.ResourceHandlerWrapper.createResource +
+ ( + String + , +
+ String + ) +
+
+ The default behavior of this method is to call ResourceHandler#createResource(String, + String) on the wrapped ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2502 + + Resource + + jakarta.faces.application.ResourceHandlerWrapper.createResource +
+ ( + String + , +
+ String + , +
+ String + ) +
+
+ The default behavior of this method is to call ResourceHandler#createResource(String, + String, String) on the wrapped ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2503 + + Resource + + jakarta.faces.application.ResourceHandlerWrapper.createResourceFromId +
+ ( + String + ) +
+
+ The default behavior of this method is to call + ResourceHandler#createResourceFromId(String) on the wrapped ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2504 + + ViewResource + + jakarta.faces.application.ResourceHandlerWrapper.createViewResource +
+ ( + FacesContext + , +
+ String + ) +
+
+ The default behavior of this method is to call ResourceHandler#createViewResource on + the wrapped ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2505 + + String + + jakarta.faces.application.ResourceHandlerWrapper.getRendererTypeForResourceName +
+ ( + String + ) +
+
+ The default behavior of this method is to call + ResourceHandler#getRendererTypeForResourceName(String) on the wrapped ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2506 + + Stream + + jakarta.faces.application.ResourceHandlerWrapper.getViewResources +
+ ( + FacesContext + , +
+ String + , +
+ int + , +
+ ResourceVisitOption[] + ) +
+
+ The default behavior of this method is to call + ResourceHandler#getViewResources(FacesContext, String, int, ResourceVisitOption...) on the wrapped + ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2507 + + Stream + + jakarta.faces.application.ResourceHandlerWrapper.getViewResources +
+ ( + FacesContext + , +
+ String + , +
+ ResourceVisitOption[] + ) +
+
+ The default behavior of this method is to call + ResourceHandler#getViewResources(FacesContext, String, ResourceVisitOption...) on the wrapped + ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2508 + + ResourceHandler + + jakarta.faces.application.ResourceHandlerWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2509 + + void + + jakarta.faces.application.ResourceHandlerWrapper.handleResourceRequest +
+ ( + FacesContext + ) +
+
+ The default behavior of this method is to call + ResourceHandler#handleResourceRequest(jakarta.faces.context.FacesContext) on the wrapped + ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2510 + + void + + jakarta.faces.application.ResourceHandlerWrapper.handleResourceRequest +
+ ( + FacesContext + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2511 + + boolean + + jakarta.faces.application.ResourceHandlerWrapper.isResourceRendered +
+ ( + FacesContext + , +
+ String + , +
+ String + ) +
+
+ The default behavior of this method is to call + ResourceHandler#isResourceRendered(FacesContext, String, String) on the wrapped ResourceHandler + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2512 + + boolean + + jakarta.faces.application.ResourceHandlerWrapper.isResourceRequest +
+ ( + FacesContext + ) +
+
+ The default behavior of this method is to call + ResourceHandler#isResourceRequest(jakarta.faces.context.FacesContext) on the wrapped ResourceHandler + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2513 + + boolean + + jakarta.faces.application.ResourceHandlerWrapper.isResourceURL +
+ ( + String + ) +
+
+ The default behavior of this method is to call ResourceHandler#isResourceURL on the + wrapped ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2514 + + boolean + + jakarta.faces.application.ResourceHandlerWrapper.libraryExists +
+ ( + String + ) +
+
+ The default behavior of this method is to call ResourceHandler#libraryExists(String) on + the wrapped ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2515 + + void + + jakarta.faces.application.ResourceHandlerWrapper.markResourceRendered +
+ ( + FacesContext + , +
+ String + , +
+ String + ) +
+
+ The default behavior of this method is to call + ResourceHandler#markResourceRendered(FacesContext, String, String) on the wrapped ResourceHandler + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2516 + + ResourceHandlerWrapper + + jakarta.faces.application.ResourceHandlerWrapper.ResourceHandlerWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:2517 + + ResourceHandlerWrapper + + jakarta.faces.application.ResourceHandlerWrapper.ResourceHandlerWrapper +
+ ( + ResourceHandler + ) +
+
+ If this resource handler has been decorated, the implementation doing the decorating + should push the implementation being wrapped to this constructor. The #getWrapped() will then return + the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2518 + + ResourceVisitOption + + jakarta.faces.application.ResourceVisitOption.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2519 + + ResourceVisitOption[] + + jakarta.faces.application.ResourceVisitOption.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2520 + + String + + jakarta.faces.application.ResourceWrapper.getContentType +
+
+
+ The default behavior of this method is to call Resource#getContentType() on the wrapped + ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2521 + + InputStream + + jakarta.faces.application.ResourceWrapper.getInputStream +
+
+
+ The default behavior of this method is to call Resource#getInputStream on the wrapped + ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2522 + + InputStream + + jakarta.faces.application.ResourceWrapper.getInputStream +
+
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2523 + + String + + jakarta.faces.application.ResourceWrapper.getLibraryName +
+
+
+ The default behavior of this method is to call Resource#getLibraryName() on the wrapped + ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2524 + + String + + jakarta.faces.application.ResourceWrapper.getRequestPath +
+
+
+ The default behavior of this method is to call Resource#getRequestPath on the wrapped + ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2525 + + String + + jakarta.faces.application.ResourceWrapper.getResourceName +
+
+
+ The default behavior of this method is to call Resource#getResourceName() on the + wrapped ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2526 + + Map + + jakarta.faces.application.ResourceWrapper.getResponseHeaders +
+
+
+ The default behavior of this method is to call Resource#getResponseHeaders on the + wrapped ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2527 + + URL + + jakarta.faces.application.ResourceWrapper.getURL +
+
+
+ The default behavior of this method is to call Resource#getURL on the wrapped + ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2528 + + Resource + + jakarta.faces.application.ResourceWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2529 + + ResourceWrapper + + jakarta.faces.application.ResourceWrapper.ResourceWrapper +
+ ( + Resource + ) +
+
+ If this resource has been decorated, the implementation doing the decorating should + push the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2530 + + ResourceWrapper + + jakarta.faces.application.ResourceWrapper.ResourceWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:2531 + + void + + jakarta.faces.application.ResourceWrapper.setContentType +
+ ( + String + ) +
+
+ The default behavior of this method is to call Resource#setContentType(String) on the + wrapped ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2532 + + void + + jakarta.faces.application.ResourceWrapper.setLibraryName +
+ ( + String + ) +
+
+ The default behavior of this method is to call Resource#setLibraryName(String) on the + wrapped ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2533 + + void + + jakarta.faces.application.ResourceWrapper.setResourceName +
+ ( + String + ) +
+
+ The default behavior of this method is to call Resource#setResourceName(String) on the + wrapped ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2534 + + boolean + + jakarta.faces.application.ResourceWrapper.userAgentNeedsUpdate +
+ ( + FacesContext + ) +
+
+ The default behavior of this method is to call Resource#userAgentNeedsUpdate on the + wrapped ResourceHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2535 + + String + + jakarta.faces.application.StateManager.getViewState +
+ ( + FacesContext + ) +
+
+ Convenience method to return the view state as a String with no RenderKit specific + markup. This default implementation of this method will call + StateManagementStrategy#saveView(FacesContext) and passing the result to and returning the resulting + value from ResponseStateManager#getViewState(jakarta.faces.context.FacesContext, Object). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2536 + + boolean + + jakarta.faces.application.StateManager.isSavingStateInClient +
+ ( + FacesContext + ) +
+
+ Method to determine if the state is saved on the client. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2537 + + StateManager + + jakarta.faces.application.StateManager.StateManager +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2538 + + void + + jakarta.faces.application.StateManager.writeState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ Save the state represented in the specified state Object instance, in an implementation + dependent manner. This method will typically simply delegate the actual writing to the writeState() + method of the ResponseStateManager instance provided by the RenderKit being used to render this + view. This method assumes that the caller has positioned the ResponseWriter at the correct position + for the saved state to be written. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2539 + + void + + jakarta.faces.application.StateManager.writeState +
+ ( + FacesContext + , +
+ Object + ) + +
+ throws + IOException +
+
+
+ when an I/O error occurs. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2540 + + String + + jakarta.faces.application.StateManagerWrapper.getViewState +
+ ( + FacesContext + ) +
+
+ The default behavior of this method is to call + StateManager#getViewState(jakarta.faces.context.FacesContext) on the wrapped StateManager object. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2541 + + StateManager + + jakarta.faces.application.StateManagerWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2542 + + boolean + + jakarta.faces.application.StateManagerWrapper.isSavingStateInClient +
+ ( + FacesContext + ) +
+
+ The default behavior of this method is to call + StateManager#isSavingStateInClient(jakarta.faces.context.FacesContext) on the wrapped StateManager + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2543 + + StateManagerWrapper + + jakarta.faces.application.StateManagerWrapper.StateManagerWrapper +
+ ( + StateManager + ) +
+
+ If this state manager has been decorated, the implementation doing the decorating + should push the implementation being wrapped to this constructor. The #getWrapped() will then return + the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2544 + + void + + jakarta.faces.application.StateManagerWrapper.writeState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ The default behavior of this method is to call + StateManager#writeState(jakarta.faces.context.FacesContext, java.lang.Object) on the wrapped + StateManager object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2545 + + void + + jakarta.faces.application.StateManagerWrapper.writeState +
+ ( + FacesContext + , +
+ Object + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2546 + + String + + jakarta.faces.application.ViewExpiredException.getMessage +
+
+
+ Return the message for this exception prepended with the view identifier if the view + identifier is not null, otherwise, return the message. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2547 + + String + + jakarta.faces.application.ViewExpiredException.getViewId +
+
+
+ Return the view identifier of this exception, or null if the view identifier is + nonexistent or unknown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2548 + + ViewExpiredException + + jakarta.faces.application.ViewExpiredException.ViewExpiredException +
+
+
+ Construct a new exception with no detail message or root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2549 + + ViewExpiredException + + jakarta.faces.application.ViewExpiredException.ViewExpiredException +
+ ( + String + ) +
+
+ Construct a new exception with the specified view identifier. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2550 + + ViewExpiredException + + jakarta.faces.application.ViewExpiredException.ViewExpiredException +
+ ( + String + , +
+ String + ) +
+
+ Construct a new exception with the specified detail message and no root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2551 + + ViewExpiredException + + jakarta.faces.application.ViewExpiredException.ViewExpiredException +
+ ( + Throwable + , +
+ String + ) +
+
+ Construct a new exception with the specified root cause. The detail message will be set + to (cause == null ? null : cause.toString() + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2552 + + ViewExpiredException + + jakarta.faces.application.ViewExpiredException.ViewExpiredException +
+ ( + String + , +
+ Throwable + , +
+ String + ) +
+
+ Construct a new exception with the specified detail message and root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2553 + + void + + jakarta.faces.application.ViewHandler.addProtectedView +
+ ( + String + ) +
+
+ Add the argument urlPattern to the thread safe Set of protected views for this + application. Compliant implementations make it so a subsequent call to + #getProtectedViewsUnmodifiable contains the argument. The runtime must support calling this method + at any time after application startup. The default implementation takes no action. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2554 + + String + + jakarta.faces.application.ViewHandler.calculateCharacterEncoding +
+ ( + FacesContext + ) +
+
+ Returns the correct character encoding to be used for this request. The following + algorithm is employed. Examine the Content-Type request header. If it has a charset parameter, + extract it and return that as the encoding. If no charset parameter was found, check for the + existence of a session by calling ExternalContext#getSession(boolean) passing false as the argument. + If that method returns true, get the session Map by calling ExternalContext#getSessionMap and look + for a value under the key given by the value of the symbolic constant + ViewHandler#CHARACTER_ENCODING_KEY. If present, return the value, converted to String. Otherwise, + return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2555 + + Locale + + jakarta.faces.application.ViewHandler.calculateLocale +
+ ( + FacesContext + ) +
+
+ Returns an appropriate Locale to use for this and subsequent requests for the current + client. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2556 + + String + + jakarta.faces.application.ViewHandler.calculateRenderKitId +
+ ( + FacesContext + ) +
+
+ Return an appropriate renderKitId for this and subsequent requests from the current + client. It is an error for this method to return null. The default return value is + jakarta.faces.render.RenderKitFactory#HTML_BASIC_RENDER_KIT. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2557 + + UIViewRoot + + jakarta.faces.application.ViewHandler.createView +
+ ( + FacesContext + , +
+ String + ) +
+
+ Create and return a new UIViewRoot instance initialized with information from the + argument FacesContext and viewId. Locate the ViewDeclarationLanguage implementation for the VDL used + in the view. The argument viewId must be converted to a physical viewId that can refer to an actual + resource suitable for use by the ViewDeclarationLanguage ViewDeclarationLanguage#createView, which + must be called by this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2558 + + String + + jakarta.faces.application.ViewHandler.deriveLogicalViewId +
+ ( + FacesContext + , +
+ String + ) +
+
+ Derive and return the viewId from the current request, or the argument input by + following the algorithm defined in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta + Faces Specification Document. Note that unlike deriveViewId(), this method does not require that a + physical view be present. This method should work correctly when the FacesServlet is invoked via + either a path mapping, extension mapping or an exact match (mapping) as defined by Servlet.12.2. + Note that path mapping is also commonly known as prefix mapping (e.g. "/faces/*") and extension + mapping as suffix mapping (e.g. "*.xhtml"). An exact match is possible where there's a servlet + mapping with an exact URL pattern such as "/foo". The default implementation of this method simply + returns requestViewId unchanged. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2559 + + String + + jakarta.faces.application.ViewHandler.deriveViewId +
+ ( + FacesContext + , +
+ String + ) +
+
+ Derive and return the viewId from the current request, or the argument input by + following the algorithm defined in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta + Faces Specification Document. This method should work correctly when the FacesServlet is invoked via + either a path mapping, extension mapping or an exact match (mapping) as defined by Servlet.12.2. + Note that path mapping is also commonly known as prefix mapping (e.g. "/faces/*") and extension + mapping as suffix mapping (e.g. "*.xhtml"). An exact match is possible where there's a servlet + mapping with an exact URL pattern such as "/foo". The default implementation of this method simply + returns requestViewId unchanged. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2560 + + String + + jakarta.faces.application.ViewHandler.getActionURL +
+ ( + FacesContext + , +
+ String + ) +
+
+ If the value returned from this method is used as the file argument to the + four-argument constructor for java.net.URL (assuming appropriate values are used for the first three + arguments), then a client making a request to the toExternalForm() of that URL will select the + argument viewId for traversing the Jakarta Faces lifecycle. Please see section 7.6.2 "Default + ViewHandler Implementation" of the Jakarta Faces Specification Document for the complete + specification, especially for details related to view protection using the + jakarta.faces.render.ResponseStateManager#NON_POSTBACK_VIEW_TOKEN_PARAM and the behavior when the + current request is to a URL for which the FacesServlet has an exact mapping as defined by + Servlet.12.2. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2561 + + String + + jakarta.faces.application.ViewHandler.getBookmarkableURL +
+ ( + FacesContext + , +
+ String + , +
+ Map + , +
+ boolean + ) +
+
+ Return a Jakarta Faces action URL derived from the viewId argument that is suitable to + be used as the target of a link in a Jakarta Faces response. Compliant implementations must + implement this method as specified in section 7.6.2 "Default ViewHandler Implementation" of the + Jakarta Faces Specification Document. The default implementation simply calls through to + #getActionURL, passing the arguments context and viewId. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2562 + + Set + + jakarta.faces.application.ViewHandler.getProtectedViewsUnmodifiable +
+
+
+ Return an unmodifiable Set of the protected views currently known to this ViewHandler + instance. Compliant implementations must return a Set that is the concatenation of the contents of + all the elements within all the in all of the application configuration resources in the current + application. The runtime must support calling this method at any time after application startup. The + default implementation returns an unmodifiable empty Set. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2563 + + String + + jakarta.faces.application.ViewHandler.getRedirectURL +
+ ( + FacesContext + , +
+ String + , +
+ Map + , +
+ boolean + ) +
+
+ Return a Jakarta Faces action URL derived from the viewId argument that is suitable to + be used by the NavigationHandler to issue a redirect request to the URL using a NonFaces request. + Compliant implementations must implement this method as specified in section 7.6.2 "Default + ViewHandler Implementation" of the Jakarta Faces Specification Document. The default implementation + simply calls through to #getActionURL, passing the arguments context and viewId. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2564 + + String + + jakarta.faces.application.ViewHandler.getResourceURL +
+ ( + FacesContext + , +
+ String + ) +
+
+ If the value returned from this method is used as the file argument to the + four-argument constructor for java.net.URL (assuming appropriate values are used for the first three + arguments), then a client making a request to the toExternalForm() of that URL will select the + argument path for direct rendering. If the specified path starts with a slash, it must be treated as + context relative; otherwise, it must be treated as relative to the action URL of the current view. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2565 + + ViewDeclarationLanguage + + jakarta.faces.application.ViewHandler.getViewDeclarationLanguage +
+ ( + FacesContext + , +
+ String + ) +
+
+ Return the ViewDeclarationLanguage instance used for this ViewHandler instance. The + default implementation must use + jakarta.faces.view.ViewDeclarationLanguageFactory#getViewDeclarationLanguage to obtain the + appropriate ViewDeclarationLanguage implementation for the argument viewId. Any exceptions thrown as + a result of invoking that method must not be swallowed. The default implementation of this method + returns null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2566 + + Stream + + jakarta.faces.application.ViewHandler.getViews +
+ ( + FacesContext + , +
+ String + , +
+ int + , +
+ ViewVisitOption[] + ) +
+
+ Return a Stream possibly lazily populated by walking the view trees of every active + ViewDeclarationLanguage rooted at a given initial path. The view tree of every + ViewDeclarationLanguage is individually traversed breadth-first as per the contract of + ViewDeclarationLanguage#getViews(FacesContext, String, int, ViewVisitOption...). The elements in the + stream are logical view ids. The maxDepth parameter is the maximum depth of directory levels to + visit for each ViewDeclarationLanguage beyond the initial path, which is always visited. The value + is relative to the root (/), not to the given initial path. E.g. given maxDepth = 3 and initial path + /foo/, visiting will proceed up to /foo/bar/, where / counts as depth 1, /foo/ as depth 2 and + /foo/bar/ as depth 3. A value lower or equal to the depth of the initial path means that only the + initial path is visited. A value of Integer#MAX_VALUE MAX_VALUE may be used to indicate that all + levels should be visited. In case more than one active ViewDeclarationLanguage is present, the order + in which view ids from each ViewDeclarationLanguage appear in the stream is undetermined, except for + the guarantee that every individual ViewDeclarationLanguage is traversed breadth-first. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2567 + + Stream + + jakarta.faces.application.ViewHandler.getViews +
+ ( + FacesContext + , +
+ String + , +
+ ViewVisitOption[] + ) +
+
+ Return a Stream possibly lazily populated by walking the view trees of every active + ViewDeclarationLanguage rooted at a given initial path. The view tree of every + ViewDeclarationLanguage is individually traversed breadth-first as per the contract of + ViewDeclarationLanguage#getViews(FacesContext, String, int, ViewVisitOption...). The elements in the + stream are logical view ids. This method works as if invoking it were equivalent to evaluating the + expression: getViews(facesContext, start, Integer.MAX_VALUE, options) Put differently, it visits all + levels of the view tree. In case more than one active ViewDeclarationLanguage is present, the order + in which view ids from each ViewDeclarationLanguage appear in the stream is undetermined, except for + the guarantee that every individual ViewDeclarationLanguage is traversed breadth-first. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2568 + + String + + jakarta.faces.application.ViewHandler.getWebsocketURL +
+ ( + FacesContext + , +
+ String + ) +
+
+ If the value returned from this method is used as the file argument to the + four-argument constructor for java.net.URL (assuming appropriate values are used for the first three + arguments), then a client making a push handshake request to the toExternalForm() of that URL will + select the argument channel for connecting the websocket push channel in the current view. It must + match the PushContext#URI_PREFIX of the endpoint. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2569 + + void + + jakarta.faces.application.ViewHandler.initView +
+ ( + FacesContext + ) +
+
+ Initialize the view for the request processing lifecycle. This method must be called at + the beginning of the Restore View Phase of the Request Processing Lifecycle. It is responsible for + performing any per-request initialization necessary to the operation of the lifycecle. The default + implementation must perform the following actions. If ExternalContext#getRequestCharacterEncoding + returns null, call #calculateCharacterEncoding and pass the result, if non-null, into the + ExternalContext#setRequestCharacterEncoding method. If ExternalContext#getRequestCharacterEncoding + returns non-null take no action. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2570 + + void + + jakarta.faces.application.ViewHandler.initView +
+ ( + FacesContext + ) + +
+ throws + FacesException +
+
+
+ if a problem occurs setting the encoding, such as the UnsupportedEncodingException + thrown by the underlying Jakarta Servlet or Portlet technology when the encoding is not supported. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2571 + + boolean + + jakarta.faces.application.ViewHandler.removeProtectedView +
+ ( + String + ) +
+
+ Remove the argument urlPattern from the thread safe Set of protected views for this + application, if present in the Set. If the argument urlPattern is not present in the Set, this + method has no effect. Compliant implementations must make it so a subsequent call to + #getProtectedViewsUnmodifiable does not contain the argument. The runtime must support calling this + method at any time after application startup. Returns true if this Set contained the argument. The + default implementation takes no action and returns false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2572 + + void + + jakarta.faces.application.ViewHandler.renderView +
+ ( + FacesContext + , +
+ UIViewRoot + ) +
+
+ Perform whatever actions are required to render the response view to the response + object associated with the current FacesContext. Otherwise, the default implementation must obtain a + reference to the ViewDeclarationLanguage for the viewId of the argument viewToRender and call its + ViewDeclarationLanguage#renderView method, returning the result and not swallowing any exceptions + thrown by that method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2573 + + void + + jakarta.faces.application.ViewHandler.renderView +
+ ( + FacesContext + , +
+ UIViewRoot + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2574 + + void + + jakarta.faces.application.ViewHandler.renderView +
+ ( + FacesContext + , +
+ UIViewRoot + ) + +
+ throws + FacesException +
+
+
+ if a Jakarta Servlet error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2575 + + UIViewRoot + + jakarta.faces.application.ViewHandler.restoreView +
+ ( + FacesContext + , +
+ String + ) +
+
+ Perform whatever actions are required to restore the view associated with the specified + FacesContext and viewId. It may delegate to the restoreView of the associated StateManager to do the + actual work of restoring the view. If there is no available state for the specified viewId, return + null. Otherwise, the default implementation must obtain a reference to the ViewDeclarationLanguage + for this viewId and call its ViewDeclarationLanguage#restoreView method, returning the result and + not swallowing any exceptions thrown by that method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2576 + + ViewHandler + + jakarta.faces.application.ViewHandler.ViewHandler +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2577 + + void + + jakarta.faces.application.ViewHandler.writeState +
+ ( + FacesContext + ) +
+
+ Take any appropriate action to either immediately write out the current state + information (by calling StateManager#writeState, or noting where state information should later be + written. This method must do nothing if the current request is an Ajax request. When responding to + Ajax requests, the state is obtained by calling StateManager#getViewState and then written into the + Ajax response during final encoding + (jakarta.faces.context.PartialViewContext#processPartial(jakarta.faces.event.PhaseId)) . + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2578 + + void + + jakarta.faces.application.ViewHandler.writeState +
+ ( + FacesContext + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2579 + + void + + jakarta.faces.application.ViewHandlerWrapper.addProtectedView +
+ ( + String + ) +
+
+ The default behavior of this method is to call ViewHandler#addProtectedView on the + wrapped ViewHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2580 + + String + + jakarta.faces.application.ViewHandlerWrapper.calculateCharacterEncoding +
+ ( + FacesContext + ) +
+
+ The default behavior of this method is to call + ViewHandler#calculateCharacterEncoding(jakarta.faces.context.FacesContext) on the wrapped + ViewHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2581 + + Locale + + jakarta.faces.application.ViewHandlerWrapper.calculateLocale +
+ ( + FacesContext + ) +
+
+ The default behavior of this method is to call + ViewHandler#calculateLocale(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2582 + + String + + jakarta.faces.application.ViewHandlerWrapper.calculateRenderKitId +
+ ( + FacesContext + ) +
+
+ The default behavior of this method is to call + ViewHandler#calculateRenderKitId(jakarta.faces.context.FacesContext) on the wrapped ViewHandler + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2583 + + UIViewRoot + + jakarta.faces.application.ViewHandlerWrapper.createView +
+ ( + FacesContext + , +
+ String + ) +
+
+ The default behavior of this method is to call + ViewHandler#createView(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2584 + + String + + jakarta.faces.application.ViewHandlerWrapper.deriveLogicalViewId +
+ ( + FacesContext + , +
+ String + ) +
+
+ The default behavior of this method is to call + ViewHandler#deriveLogicalViewId(jakarta.faces.context.FacesContext, String) on the wrapped + ViewHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2585 + + String + + jakarta.faces.application.ViewHandlerWrapper.deriveViewId +
+ ( + FacesContext + , +
+ String + ) +
+
+ The default behavior of this method is to call + ViewHandler#deriveViewId(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2586 + + String + + jakarta.faces.application.ViewHandlerWrapper.getActionURL +
+ ( + FacesContext + , +
+ String + ) +
+
+ The default behavior of this method is to call + ViewHandler#getActionURL(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2587 + + String + + jakarta.faces.application.ViewHandlerWrapper.getBookmarkableURL +
+ ( + FacesContext + , +
+ String + , +
+ Map + , +
+ boolean + ) +
+
+ The default behavior of this method is to call + ViewHandler#getBookmarkableURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean) + on the wrapped ViewHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2588 + + Set + + jakarta.faces.application.ViewHandlerWrapper.getProtectedViewsUnmodifiable +
+
+
+ The default behavior of this method is to call + ViewHandler#getProtectedViewsUnmodifiable on the wrapped ViewHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2589 + + String + + jakarta.faces.application.ViewHandlerWrapper.getRedirectURL +
+ ( + FacesContext + , +
+ String + , +
+ Map + , +
+ boolean + ) +
+
+ The default behavior of this method is to call + ViewHandler#getRedirectURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean) on + the wrapped ViewHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2590 + + String + + jakarta.faces.application.ViewHandlerWrapper.getResourceURL +
+ ( + FacesContext + , +
+ String + ) +
+
+ The default behavior of this method is to call + ViewHandler#getResourceURL(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2591 + + ViewDeclarationLanguage + + jakarta.faces.application.ViewHandlerWrapper.getViewDeclarationLanguage +
+ ( + FacesContext + , +
+ String + ) +
+
+ The default behavior of this method is to call ViewHandler#getViewDeclarationLanguage + on the wrapped ViewHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2592 + + Stream + + jakarta.faces.application.ViewHandlerWrapper.getViews +
+ ( + FacesContext + , +
+ String + , +
+ ViewVisitOption[] + ) +
+
+ The default behavior of this method is to call ViewHandler#getViews(FacesContext, + String, ViewVisitOption...) on the wrapped ViewHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2593 + + Stream + + jakarta.faces.application.ViewHandlerWrapper.getViews +
+ ( + FacesContext + , +
+ String + , +
+ int + , +
+ ViewVisitOption[] + ) +
+
+ The default behavior of this method is to call ViewHandler#getViews(FacesContext, + String, int, ViewVisitOption...) on the wrapped ViewHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2594 + + String + + jakarta.faces.application.ViewHandlerWrapper.getWebsocketURL +
+ ( + FacesContext + , +
+ String + ) +
+
+ The default behavior of this method is to call + ViewHandler#getWebsocketURL(FacesContext, String) on the wrapped ViewHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2595 + + ViewHandler + + jakarta.faces.application.ViewHandlerWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2596 + + void + + jakarta.faces.application.ViewHandlerWrapper.initView +
+ ( + FacesContext + ) +
+
+ The default behavior of this method is to call ViewHandler#initView on the wrapped + ViewHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2597 + + void + + jakarta.faces.application.ViewHandlerWrapper.initView +
+ ( + FacesContext + ) + +
+ throws + FacesException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2598 + + boolean + + jakarta.faces.application.ViewHandlerWrapper.removeProtectedView +
+ ( + String + ) +
+
+ The default behavior of this method is to call ViewHandler#removeProtectedView on the + wrapped ViewHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2599 + + void + + jakarta.faces.application.ViewHandlerWrapper.renderView +
+ ( + FacesContext + , +
+ UIViewRoot + ) +
+
+ The default behavior of this method is to call + ViewHandler#renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot) on + the wrapped ViewHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2600 + + void + + jakarta.faces.application.ViewHandlerWrapper.renderView +
+ ( + FacesContext + , +
+ UIViewRoot + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2601 + + void + + jakarta.faces.application.ViewHandlerWrapper.renderView +
+ ( + FacesContext + , +
+ UIViewRoot + ) + +
+ throws + FacesException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2602 + + UIViewRoot + + jakarta.faces.application.ViewHandlerWrapper.restoreView +
+ ( + FacesContext + , +
+ String + ) +
+
+ The default behavior of this method is to call + ViewHandler#restoreView(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2603 + + ViewHandlerWrapper + + jakarta.faces.application.ViewHandlerWrapper.ViewHandlerWrapper +
+ ( + ViewHandler + ) +
+
+ If this view handler has been decorated, the implementation doing the decorating should + push the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2604 + + ViewHandlerWrapper + + jakarta.faces.application.ViewHandlerWrapper.ViewHandlerWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:2605 + + void + + jakarta.faces.application.ViewHandlerWrapper.writeState +
+ ( + FacesContext + ) +
+
+ The default behavior of this method is to call + ViewHandler#writeState(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2606 + + void + + jakarta.faces.application.ViewHandlerWrapper.writeState +
+ ( + FacesContext + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2607 + + URL + + jakarta.faces.application.ViewResource.getURL +
+
+
+ Return an actual URL instance that refers to this resource instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2608 + + ViewResource + + jakarta.faces.application.ViewResource.ViewResource +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2609 + + ViewVisitOption + + jakarta.faces.application.ViewVisitOption.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2610 + + ViewVisitOption[] + + jakarta.faces.application.ViewVisitOption.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2611 + + void + + jakarta.faces.component.ActionSource.addActionListener +
+ ( + ActionListener + ) +
+
+ Add a new ActionListener to the set of listeners interested in being notified when + ActionEvents occur. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2612 + + ActionListener[] + + jakarta.faces.component.ActionSource.getActionListeners +
+
+
+ Return the set of registered ActionListeners for this ActionSource instance. If there + are no registered listeners, a zero-length array is returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2613 + + boolean + + jakarta.faces.component.ActionSource.isImmediate +
+
+
+ Return a flag indicating that the default ActionListener provided by the Jakarta Faces + implementation should be executed immediately (that is, during Apply Request Values phase of the + request processing lifecycle), rather than waiting until the Invoke Application phase. The default + value for this property must be false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2614 + + void + + jakarta.faces.component.ActionSource.removeActionListener +
+ ( + ActionListener + ) +
+
+ Remove an existing ActionListener (if any) from the set of listeners interested in + being notified when ActionEvents occur. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2615 + + void + + jakarta.faces.component.ActionSource.setImmediate +
+ ( + boolean + ) +
+
+ Set the "immediate execution" flag for this UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2616 + + MethodExpression + + jakarta.faces.component.ActionSource2.getActionExpression +
+
+
+ Return the MethodExpression pointing at the application action to be invoked, if this + UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of + the request processing lifecycle, depending on the value of the immediate property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2617 + + void + + jakarta.faces.component.ActionSource2.setActionExpression +
+ ( + MethodExpression + ) +
+
+ Set the MethodExpression pointing at the appication action to be invoked, if this + UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of + the request processing lifecycle, depending on the value of the immediate property. Any method + referenced by such an expression must be public, with a return type of String, and accept no + parameters. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2618 + + void + + jakarta.faces.component.ContextCallback.invokeContextCallback +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ This method will be called by an implementation of UIComponent#invokeOnComponent and + must be passed the component with the clientId given as an argument to invokeOnComponent. At the + point in time when this method is called, the argument target is guaranteed to be in the proper + state with respect to its ancestors in the View. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2619 + + String + + jakarta.faces.component.Doctype.getPublic +
+
+
+ Returns the public identifier of the document, or null if there is none. For example, + "-//W3C//DTD XHTML 1.1//EN". + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2620 + + String + + jakarta.faces.component.Doctype.getRootElement +
+
+
+ Returns the name of the first element in the document, never null. For example, "html". + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2621 + + String + + jakarta.faces.component.Doctype.getSystem +
+
+
+ Returns the system identifier of the document, or null if there is none. For example, + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd". + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2622 + + void + + jakarta.faces.component.EditableValueHolder.addValidator +
+ ( + Validator + ) +
+
+ Add a Validator instance to the set associated with this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2623 + + void + + jakarta.faces.component.EditableValueHolder.addValueChangeListener +
+ ( + ValueChangeListener + ) +
+
+ Add a new ValueChangeListener to the set of listeners interested in being notified when + ValueChangeEvents occur. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2624 + + Object + + jakarta.faces.component.EditableValueHolder.getSubmittedValue +
+
+
+ Return the submittedValue value of this component. This method should only be used by + the encodeBegin() and/or encodeEnd() methods of this component, or its corresponding Renderer. The + action taken based on whether the value is null, empty, or non-null is determined based on the value + of the jakarta.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULLcontext-param. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2625 + + Validator[] + + jakarta.faces.component.EditableValueHolder.getValidators +
+
+
+ Return the set of registered Validators for this component instance. If there are no + registered validators, a zero-length array is returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2626 + + ValueChangeListener[] + + jakarta.faces.component.EditableValueHolder.getValueChangeListeners +
+
+
+ Return the set of registered ValueChangeListeners for this component instance. If there + are no registered listeners, a zero-length array is returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2627 + + boolean + + jakarta.faces.component.EditableValueHolder.isImmediate +
+
+
+ Return the "immediate" state for this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2628 + + boolean + + jakarta.faces.component.EditableValueHolder.isLocalValueSet +
+
+
+ Return the "local value set" state for this component. Calls to setValue() + automatically reset this property to true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2629 + + boolean + + jakarta.faces.component.EditableValueHolder.isRequired +
+
+
+ Return the "required field" state for this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2630 + + boolean + + jakarta.faces.component.EditableValueHolder.isValid +
+
+
+ Return a flag indicating whether the local value of this component is valid (no + conversion error has occurred). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2631 + + void + + jakarta.faces.component.EditableValueHolder.removeValidator +
+ ( + Validator + ) +
+
+ Remove a Validator instance from the set associated with this component, if it was + previously associated. Otherwise, do nothing. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2632 + + void + + jakarta.faces.component.EditableValueHolder.removeValueChangeListener +
+ ( + ValueChangeListener + ) +
+
+ Remove an existing ValueChangeListener (if any) from the set of listeners interested in + being notified when ValueChangeEvents occur. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2633 + + void + + jakarta.faces.component.EditableValueHolder.resetValue +
+
+
+ Convenience method to reset this component's value to the un-initialized state. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2634 + + void + + jakarta.faces.component.EditableValueHolder.setImmediate +
+ ( + boolean + ) +
+
+ Set the "immediate" state for this component. When set to true, the component's value + will be converted and validated immediately in the Apply Request Values phase, and ValueChangeEvents + will be delivered in that phase as well. The default value for this property must be false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2635 + + void + + jakarta.faces.component.EditableValueHolder.setLocalValueSet +
+ ( + boolean + ) +
+
+ Sets the "local value set" state for this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2636 + + void + + jakarta.faces.component.EditableValueHolder.setRequired +
+ ( + boolean + ) +
+
+ Set the "required field" state for this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2637 + + void + + jakarta.faces.component.EditableValueHolder.setSubmittedValue +
+ ( + Object + ) +
+
+ Set the submittedValue value of this component. This method should only be used by the + decode() and validate() method of this component, or its corresponding Renderer. The action taken + based on whether the value is null, empty, or non-null is determined based on the value of the + jakarta.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULLcontext-param. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2638 + + void + + jakarta.faces.component.EditableValueHolder.setValid +
+ ( + boolean + ) +
+
+ Set a flag indicating whether the local value of this component is valid (no conversion + error has occurred). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2639 + + boolean + + jakarta.faces.component.FacesComponent.createTag +
+
+
+ If the value of this attribute is true, the runtime must create a Facelet tag handler, + that extends from jakarta.faces.view.facelets.ComponentHandler, suitable for use in pages under the + tag library with namespace given by the value of the #namespace attribute. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2640 + + String + + jakarta.faces.component.FacesComponent.namespace +
+
+
+ If the value of the #createTag attribute is true, the value of this attribute is taken + to be the tag library namespace into which this component is placed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2641 + + String + + jakarta.faces.component.FacesComponent.tagName +
+
+
+ If the value of the #createTag attribute is true, the runtime must use this value as + the tag name for including an instance of the component annotated with this annotation in a view. If + this attribute is not specified on a usage of this annotation, the simple name of the class on which + this annotation is declared, with the first character lowercased, is taken to be the value. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2642 + + String + + jakarta.faces.component.FacesComponent.value +
+
+
+ The value of this annotation attribute is taken to be the component-type with which + instances of this class of component can be instantiated by calling + jakarta.faces.application.Application#createComponent(java.lang.String). If no value is specified, + or the value is null, the value is taken to be the return of calling getSimpleName on the class to + which this annotation is attached and lowercasing the first character. If more than one component + with this derived name is found, the results are undefined. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2643 + + void + + jakarta.faces.component.PartialStateHolder.clearInitialState +
+
+
+ Reset the PartialStateHolder to a non-delta tracking state. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2644 + + boolean + + jakarta.faces.component.PartialStateHolder.initialStateMarked +
+
+
+ Return true if delta state changes are being tracked, otherwise false + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2645 + + void + + jakarta.faces.component.PartialStateHolder.markInitialState +
+
+
+ The runtime must ensure that the #markInitialState method is called on each instance of + this interface in the view at the appropriate time to indicate the component is in its initial + state. The implementor of the interface must ensure that #initialStateMarked returns true from the + time markInitialState() is called until #clearInitialState is called, after which time + initialStateMarked() must return false. Also, during the time that the instance returns true from + initialStateMarked(), the implementation must return only the state that has changed in its + implementation of StateHolder#saveState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2646 + + void + + jakarta.faces.component.StateHelper.add +
+ ( + Serializable + , +
+ Object + ) +
+
+ Store the specified value in a List that is internal to the StateHelper. It's important + to note for delta tracking that any modifications to the internal List be made through this method + or StateHelper#remove(java.io.Serializable, Object). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2647 + + Object + + jakarta.faces.component.StateHelper.eval +
+ ( + Serializable + ) +
+
+ Attempts to find a value associated with the specified key, using the value expression + collection from the component if no such value is found. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2648 + + Object + + jakarta.faces.component.StateHelper.eval +
+ ( + Serializable + , +
+ Object + ) +
+
+ Performs the same logic as #eval(java.io.Serializable) } but if no value is found, this + will return the specified defaultValue + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2649 + + Object + + jakarta.faces.component.StateHelper.eval +
+ ( + Serializable + , +
+ Supplier + ) +
+
+ Performs the same logic as #eval(java.io.Serializable) } but if no value is found, this + will return the return-value of the defaultValueSupplier + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2650 + + Object + + jakarta.faces.component.StateHelper.get +
+ ( + Serializable + ) +
+
+ Return the value currently associated with the specified key if any. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2651 + + Object + + jakarta.faces.component.StateHelper.put +
+ ( + Serializable + , +
+ Object + ) +
+
+ Return the previously stored value and store the specified key/value pair. This is + intended to store data that would otherwise reside in an instance variable on the component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2652 + + Object + + jakarta.faces.component.StateHelper.put +
+ ( + Serializable + , +
+ String + , +
+ Object + ) +
+
+ Store the specified mapKey/value in a Map that is internal to the helper, and return + the previously stored value. The Map will then be associated with key. It's important to note for + delta tracking that any modifications to the internal Map be made through this method or + StateHelper#remove(java.io.Serializable, Object). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2653 + + Object + + jakarta.faces.component.StateHelper.remove +
+ ( + Serializable + ) +
+
+ Remove the key/value pair from the helper, returning the value previously stored under + this key. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2654 + + Object + + jakarta.faces.component.StateHelper.remove +
+ ( + Serializable + , +
+ Object + ) +
+
+ Remove a value from the inner data structure. Look in the inner data structure for the + value at the given key. If the value is a Map, remove and return the value under the key given by + the valueOrKey argument. If the value is a Collection, simply remove the value given by the argument + valueOrKey and return null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2655 + + boolean + + jakarta.faces.component.StateHolder.isTransient +
+
+
+ If true, the Object implementing this interface must not participate in state saving or + restoring. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2656 + + void + + jakarta.faces.component.StateHolder.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ Perform any processing required to restore the state from the entries in the state + Object. If the class that implements this interface has references to instances that also implement + StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the + #restoreState method on all those instances as well. If the state argument is null, take no action + and return. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2657 + + Object + + jakarta.faces.component.StateHolder.saveState +
+ ( + FacesContext + ) +
+
+ Gets the state of the instance as a Serializable Object. If the class that implements + this interface has references to instances that implement StateHolder (such as a UIComponent with + event handlers, validators, etc.) this method must call the #saveState method on all those instances + as well. This method must not save the state of children and facets. That is done via the + jakarta.faces.application.StateManager This method must not alter the state of the implementing + object. In other words, after executing this code: Object state = component.saveState(facesContext); + component should be the same as before executing it. The return from this method must be + Serializable + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2658 + + void + + jakarta.faces.component.StateHolder.setTransient +
+ ( + boolean + ) +
+
+ Denotes whether or not the Object implementing this interface must or must not + participate in state saving or restoring. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2659 + + Object + + jakarta.faces.component.TransientStateHelper.getTransient +
+ ( + Object + ) +
+
+ Return the value currently associated with the specified key if any. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2660 + + Object + + jakarta.faces.component.TransientStateHelper.getTransient +
+ ( + Object + , +
+ Object + ) +
+
+ Performs the same logic as #getTransient } but if no value is found, this will return + the specified defaultValue + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2661 + + Object + + jakarta.faces.component.TransientStateHelper.putTransient +
+ ( + Object + , +
+ Object + ) +
+
+ Return the previously stored value and store the specified key/value pair. This is + intended to store data that would otherwise reside in an instance variable on the component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2662 + + void + + jakarta.faces.component.TransientStateHolder.restoreTransientState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ Restore the "transient state" using the object passed as state. If the state argument + is null clear any previous transient state if any and return. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2663 + + Object + + jakarta.faces.component.TransientStateHolder.saveTransientState +
+ ( + FacesContext + ) +
+
+ Return the object containing related "transient states". that could be used later to + restore the "transient state". + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2664 + + String + + jakarta.faces.component.UIColumn.getFamily +
+
+
+ Get the component family. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2665 + + UIComponent + + jakarta.faces.component.UIColumn.getFooter +
+
+
+ Return the footer facet of the column (if any). A convenience method for + getFacet("footer"). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2666 + + UIComponent + + jakarta.faces.component.UIColumn.getHeader +
+
+
+ Return the header facet of the column (if any). A convenience method for + getFacet("header"). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2667 + + void + + jakarta.faces.component.UIColumn.setFooter +
+ ( + UIComponent + ) +
+
+ Set the footer facet of the column. A convenience method for getFacets().put("footer", + footer). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2668 + + void + + jakarta.faces.component.UIColumn.setHeader +
+ ( + UIComponent + ) +
+
+ Set the header facet of the column. A convenience method for getFacets().put("header", + header). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2669 + + UIColumn + + jakarta.faces.component.UIColumn.UIColumn +
+
+
+ Create a new UIColumn instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2670 + + void + + jakarta.faces.component.UICommand.broadcast +
+ ( + FacesEvent + ) +
+
+ In addition to to the default UIComponent#broadcast processing, pass the ActionEvent + being broadcast to the method referenced by actionListener (if any), and to the default + ActionListener registered on the jakarta.faces.application.Application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2671 + + void + + jakarta.faces.component.UICommand.broadcast +
+ ( + FacesEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ Signal the Jakarta Faces implementation that no further processing on the current event + should be performed + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2672 + + MethodExpression + + jakarta.faces.component.UICommand.getActionExpression +
+
+
+ Return the MethodExpression pointing at the application action to be invoked, if this + UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of + the request processing lifecycle, depending on the value of the immediate property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2673 + + ActionListener[] + + jakarta.faces.component.UICommand.getActionListeners +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2674 + + String + + jakarta.faces.component.UICommand.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2675 + + Object + + jakarta.faces.component.UICommand.getValue +
+
+
+ Returns the value property of the UICommand. This is most often rendered as a label. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2676 + + boolean + + jakarta.faces.component.UICommand.isImmediate +
+
+
+ The immediate flag. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2677 + + void + + jakarta.faces.component.UICommand.queueEvent +
+ ( + FacesEvent + ) +
+
+ Intercept queueEvent and take the following action. If the event is an ActionEvent, + obtain the UIComponent instance from the event. If the component is an ActionSource obtain the value + of its "immediate" property. If it is true, mark the phaseId for the event to be + PhaseId.APPLY_REQUEST_VALUES otherwise, mark the phaseId to be PhaseId.INVOKE_APPLICATION. The event + must be passed on to super.queueEvent() before returning from this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2678 + + void + + jakarta.faces.component.UICommand.setActionExpression +
+ ( + MethodExpression + ) +
+
+ Set the MethodExpression pointing at the appication action to be invoked, if this + UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of + the request processing lifecycle, depending on the value of the immediate property. Any method + referenced by such an expression must be public, with a return type of String, and accept no + parameters. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2679 + + void + + jakarta.faces.component.UICommand.setImmediate +
+ ( + boolean + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2680 + + void + + jakarta.faces.component.UICommand.setValue +
+ ( + Object + ) +
+
+ Sets the value property of the UICommand. This is most often rendered as a label. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2681 + + void + + jakarta.faces.component.UIComponent.broadcast +
+ ( + FacesEvent + ) +
+
+ Broadcast the specified FacesEvent to all registered event listeners who have expressed + an interest in events of this type. Listeners are called in the order in which they were added. If + the event is an instance of jakarta.faces.event.BehaviorEvent and the current component is the + source of the event call jakarta.faces.event.BehaviorEvent#getBehavior to get the + jakarta.faces.component.behavior.Behavior for the event. Call + jakarta.faces.component.behavior.Behavior#broadcast(jakarta.faces.event.BehaviorEvent) on the + Behavior instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2682 + + void + + jakarta.faces.component.UIComponent.broadcast +
+ ( + FacesEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ Signal the Jakarta Faces implementation that no further processing on the current event + should be performed + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2683 + + void + + jakarta.faces.component.UIComponent.clearInitialState +
+
+
+ An implementation of PartialStateHolder#clearInitialState, this method is called by the + runtime to tell the instance to stop tracking state changes. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2684 + + void + + jakarta.faces.component.UIComponent.encodeAll +
+ ( + FacesContext + ) +
+
+ If this component returns true from #isRendered, take the following action. Render this + component and all its children that return true from isRendered(), regardless of the value of the + #getRendersChildren flag. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2685 + + void + + jakarta.faces.component.UIComponent.encodeAll +
+ ( + FacesContext + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs while rendering + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2686 + + Map + + jakarta.faces.component.UIComponent.getAttributes +
+
+
+ Return a mutable Map representing the attributes (and properties, see below) associated + wth this UIComponent, keyed by attribute name (which must be a String). The returned implementation + must support all of the standard and optional Map methods, plus support the following additional + requirements: The Map implementation must implement the java.io.Serializable interface. Any attempt + to add a null key or value must throw a NullPointerException. Any attempt to add a key that is not a + String must throw a ClassCastException. If the attribute name specified as a key matches a property + of this UIComponent's implementation class, the following methods will have special behavior: + containsKey - Return false. get() - If the property is readable, call the getter method and return + the returned value (wrapping primitive values in their corresponding wrapper classes); otherwise + throw IllegalArgumentException. put() - If the property is writeable, call the setter method to set + the corresponding value (unwrapping primitive values in their corresponding wrapper classes). If the + property is not writeable, or an attempt is made to set a property of primitive type to null, throw + IllegalArgumentException. remove - Throw IllegalArgumentException. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2687 + + List + + jakarta.faces.component.UIComponent.getChildren +
+
+
+ Return a mutable List representing the child UIComponents associated with this + component. The returned implementation must support all of the standard and optional List methods, + plus support the following additional requirements: The List implementation must implement the + java.io.Serializable interface. Any attempt to add a null must throw a NullPointerException Any + attempt to add an object that does not implement UIComponent must throw a ClassCastException. + Whenever a new child component is added, the parent property of the child must be set to this + component instance. If the parent property of the child was already non-null, the child must first + be removed from its previous parent (where it may have been either a child or a facet). Whenever an + existing child component is removed, the parent property of the child must be set to null. After the + child component has been added to the view, jakarta.faces.application.Application#publishEvent must + be called, passing jakarta.faces.event.PostAddToViewEvent.class as the first argument and the newly + added component as the second argument if any the following cases are true. + jakarta.faces.context.FacesContext#getCurrentPhaseId returns + jakarta.faces.event.PhaseId#RESTORE_VIEW and partial state saving is enabled. + jakarta.faces.context.FacesContext#isPostback returns false and + jakarta.faces.context.FacesContext#getCurrentPhaseId returns something other than + jakarta.faces.event.PhaseId#RESTORE_VIEW + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2688 + + String + + jakarta.faces.component.UIComponent.getClientId +
+
+
+ Enable Jakarta Expression Language to access the clientId of a component. This is + particularly useful in combination with the component and cc implicit objects. A default + implementation is provided that simply calls FacesContext#getCurrentInstance and then calls through + to #getClientId(FacesContext). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2689 + + UIComponent + + jakarta.faces.component.UIComponent.getCompositeComponentParent +
+ ( + UIComponent + ) +
+
+ Finds the nearest composite component parent of the specified component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2690 + + String + + jakarta.faces.component.UIComponent.getContainerClientId +
+ ( + FacesContext + ) +
+
+ Allow components that implement NamingContainer to selectively disable prepending their + clientId to their descendent's clientIds by breaking the prepending logic into a separately callable + method. See #getClientId for usage. By default, this method will call through to #getClientId and + return the result. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2691 + + UIComponent + + jakarta.faces.component.UIComponent.getCurrentComponent +
+ ( + FacesContext + ) +
+
+ Return the UIComponent instance that is currently processing. This is equivalent to + evaluating the Jakarta Expression Language expression "#{component}" and doing a getValue operation + on the resultant ValueExpression. This method must return null if there is no currently processing + UIComponent + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2692 + + UIComponent + + jakarta.faces.component.UIComponent.getCurrentCompositeComponent +
+ ( + FacesContext + ) +
+
+ Return the closest ancestor component, relative to the component returned from + #getCurrentComponent, that is a composite component, or null if no such component exists. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2693 + + int + + jakarta.faces.component.UIComponent.getFacetCount +
+
+
+ Return the number of facet UIComponents that are associated with this UIComponent. If + there are no facets, this method must return 0. The method must not cause the creation of a facet + component map. For backwards compatability with classes that extend UIComponent directly, a default + implementation is provided that simply calls #getFacets and then calls the size() method on the + returned Map. A more optimized version of this method is provided in UIComponentBase#getFacetCount. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2694 + + Map + + jakarta.faces.component.UIComponent.getFacets +
+
+
+ Return a mutable Map representing the facet UIComponents associated with this + UIComponent, keyed by facet name (which must be a String). The returned implementation must support + all of the standard and optional Map methods, plus support the following additional requirements: + The Map implementation must implement the java.io.Serializable interface. Any attempt to add a null + key or value must throw a NullPointerException. Any attempt to add a key that is not a String must + throw a ClassCastException. Any attempt to add a value that is not a UIComponent must throw a + ClassCastException. Whenever a new facet UIComponent is added: The parent property of the component + must be set to this component instance. If the parent property of the component was already + non-null, the component must first be removed from its previous parent (where it may have been + either a child or a facet). Whenever an existing facet UIComponent is removed: The parent property + of the facet must be set to null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2695 + + String + + jakarta.faces.component.UIComponent.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2696 + + String + + jakarta.faces.component.UIComponent.getId +
+
+
+ Return the component identifier of this UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2697 + + List + + jakarta.faces.component.UIComponent.getListenersForEventClass +
+ ( + Class + ) +
+
+ This implementation throws UnsupportedOperationException and is provided for the sole + purpose of not breaking existing applications that extend this class. UIComponentBase provides the + implementation of this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2698 + + UIComponent + + jakarta.faces.component.UIComponent.getNamingContainer +
+
+
+ Starting with "this", return the closest component in the ancestry that is a + NamingContainer or null if none can be found. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2699 + + Map + + jakarta.faces.component.UIComponent.getPassThroughAttributes +
+
+
+ This is a convenience method that simply calls #getPassThroughAttributes(boolean), + passing true as the argument. This method must never return null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2700 + + Map + + jakarta.faces.component.UIComponent.getPassThroughAttributes +
+ ( + boolean + ) +
+
+ This method has the same specification as #getPassThroughAttributes() except that it is + allowed to return null if and only if the argument create is false and no pass through attribute + data structure exists for this instance. The returned Map implementation must support all of the + standard and optional Map methods, plus support the following additional requirements. The map must + be stored in using #getStateHelper. The Map implementation must implement java.io.Serializable. Any + attempt to add a null key or value must throw a NullPointerException. Any attempt to add a key that + is not a String must throw an IllegalArgumentException. For backward compatibility with components + that extend directly from this class, a default implementation is provided that returns the empty + map. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2701 + + Map + + jakarta.faces.component.UIComponent.getResourceBundleMap +
+
+
+ Return a Map of the ResourceBundle for this component. A component may have a + ResourceBundle associated with it. This bundle may contain localized properties relating to + instances of this component. The default implementation first looks for a ResourceBundle with a base + name equal to the fully qualified class name of the current UIComponent this and Locale equal to the + Locale of the current UIViewRoot. If no such bundle is found, and the component is a composite + component, let resourceName be the resourceName of the Resource for this composite component, + replacing the file extension with ".properties". Let libraryName be the libraryName of the the + Resource for this composite component. Call + jakarta.faces.application.ResourceHandler#createResource(java.lang.String,java.lang.String), passing + the derived resourceName and libraryName. Note that this will automatically allow for the + localization of the ResourceBundle due to the localization facility implemented in createResource, + which is specified in section 2.6.1.3 "Resource Identifiers" of the Jakarta Faces Specification + Document. If the resultant Resource exists and can be found, the InputStream for the resource is + used to create a ResourceBundle. If either of the two previous steps for obtaining the + ResourceBundle for this component is successful, the ResourceBundle is wrapped in a Map and + returned. Otherwise Collections.EMPTY_MAP is returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2702 + + TransientStateHelper + + jakarta.faces.component.UIComponent.getTransientStateHelper +
+
+
+ Return the TransientStateHelper instance for this UIComponent instance. The default + implementation simply calls through to #getTransientStateHelper(boolean) passing true as the + argument. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2703 + + TransientStateHelper + + jakarta.faces.component.UIComponent.getTransientStateHelper +
+ ( + boolean + ) +
+
+ Return the TransientStateHelper instance for this UIComponent instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2704 + + ValueExpression + + jakarta.faces.component.UIComponent.getValueExpression +
+ ( + String + ) +
+
+ Return the ValueExpression used to calculate the value for the specified attribute or + property name, if any. This method must be overridden and implemented for components that comply + with Jakarta Faces 1.2 and later. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2705 + + boolean + + jakarta.faces.component.UIComponent.initialStateMarked +
+
+
+ An implementation of PartialStateHolder#initialStateMarked, this method is called by + the runtime to test if the PartialStateHolder#markInitialState method was called. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2706 + + boolean + + jakarta.faces.component.UIComponent.invokeOnComponent +
+ ( + FacesContext + , +
+ String + , +
+ ContextCallback + ) +
+
+ Starting at this component in the View hierarchy, search for a component with a + clientId equal to the argument clientId and, if found, call the + ContextCallback#invokeContextCallback method on the argument callback, passing the current + FacesContext and the found component as arguments. This method is similar to #findComponent but it + does not support the leading UINamingContainer#getSeparatorChar syntax for searching from the root + of the View. The default implementation will first check if this.getClientId() is equal to the + argument clientId. If so, first call #pushComponentToEL, then call the + ContextCallback#invokeContextCallback method on the argument callback, passing through the + FacesContext argument and passing this as the component argument. Then call #popComponentFromEL. If + an Exception is thrown by the callback, wrap it in a FacesException and re-throw it. Otherwise, + return true. Otherwise, for each component returned by #getFacetsAndChildren, call + invokeOnComponent() passing the arguments to this method, in order. The first time + invokeOnComponent() returns true, abort traversing the rest of the Iterator and return true. When + calling ContextCallback#invokeContextCallback the implementation of this method must guarantee that + the state of the component passed to the callback correctly reflects the component's position in the + View hierarchy with respect to any state found in the argument clientId. For example, an iterating + component such as UIData will need to set its row index to correctly reflect the argument clientId + before finding the appropriate child component backed by the correct row. When the callback returns, + either normally or by throwing an Exception the implementation of this method must restore the state + of the view to the way it was before invoking the callback. If none of the elements from + #getFacetsAndChildren returned true from invokeOnComponent(), return false. Simple usage example to + find a component by clientId. private UIComponent found = null; private void doFind(FacesContext + context, String clientId) { context.getViewRoot().invokeOnComponent(context, clientId, new + ContextCallback() { public void invokeContextCallback(FacesContext context, UIComponent component) { + found = component; } }); } + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2707 + + boolean + + jakarta.faces.component.UIComponent.invokeOnComponent +
+ ( + FacesContext + , +
+ String + , +
+ ContextCallback + ) + +
+ throws + FacesException +
+
+
+ if the argument Callback throws an Exception, it is wrapped in a FacesException and + re-thrown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2708 + + boolean + + jakarta.faces.component.UIComponent.isCompositeComponent +
+ ( + UIComponent + ) +
+
+ Return true if component is a composite component, otherwise false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2709 + + boolean + + jakarta.faces.component.UIComponent.isInView +
+
+
+ Return true if this component is within the view hierarchy otherwise false + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2710 + + void + + jakarta.faces.component.UIComponent.markInitialState +
+
+
+ An implementation of PartialStateHolder#markInitialState, this method is called by the + runtime to indicate that the instance should start tracking changes to its state. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2711 + + void + + jakarta.faces.component.UIComponent.popComponentFromEL +
+ ( + FacesContext + ) +
+
+ Pop the current UIComponent from the FacesContext attributes map so that the previous + UIComponent, if any, becomes the current component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2712 + + void + + jakarta.faces.component.UIComponent.processEvent +
+ ( + ComponentSystemEvent + ) +
+
+ The default implementation performs the following action. If the argument event is an + instance of PostRestoreStateEvent, call this.#getValueExpression passing the literal string + #8220;binding #8221;, without the quotes, as the argument. If the result is non-null, set the value + of the ValueExpression to be this. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2713 + + void + + jakarta.faces.component.UIComponent.processEvent +
+ ( + ComponentSystemEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2714 + + void + + jakarta.faces.component.UIComponent.processRestoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ Perform the component tree processing required by the Restore View phase of the request + processing lifecycle for all facets of this component, all children of this component, and this + component itself, as follows. Call the restoreState() method of this component. Call + UIComponent#pushComponentToEL. Call the processRestoreState() method of all facets and children of + this UIComponent in the order determined by a call to getFacetsAndChildren(). After returning from + the processRestoreState() method on a child or facet, call UIComponent#popComponentFromEL This + method may not be called if the state saving method is set to server. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2715 + + Object + + jakarta.faces.component.UIComponent.processSaveState +
+ ( + FacesContext + ) +
+
+ Perform the component tree processing required by the state saving portion of the + Render Response phase of the request processing lifecycle for all facets of this component, all + children of this component, and this component itself, as follows. consult the transient property of + this component. If true, just return null. Call #pushComponentToEL. Call the processSaveState() + method of all facets and children of this UIComponent in the order determined by a call to + getFacetsAndChildren(), skipping children and facets that are transient. Ensure that + #popComponentFromEL is called correctly after each child or facet. Call the saveState() method of + this component. Encapsulate the child state and your state into a Serializable Object and return it. + This method may not be called if the state saving method is set to server. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2716 + + void + + jakarta.faces.component.UIComponent.pushComponentToEL +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Push the current UIComponent this to the FacesContext attribute map saving the previous + UIComponent for a subsequent call to #popComponentFromEL. This method and popComponentFromEL() form + the basis for the contract that enables the Jakarta Expression Language Expression "#{component}" to + resolve to the "current" component that is being processed in the lifecycle. The requirements for + when pushComponentToEL() and popComponentFromEL() must be called are specified as needed in the + javadoc for this class. After pushComponentToEL() returns, a call to #getCurrentComponent must + return this UIComponent instance until popComponentFromEL() is called, after which point the + previous UIComponent instance will be returned from getCurrentComponent() + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2717 + + void + + jakarta.faces.component.UIComponent.queueEvent +
+ ( + FacesEvent + ) +
+
+ Queue an event for broadcast at the end of the current request processing lifecycle + phase. The default implementation in UIComponentBase must delegate this call to the queueEvent() + method of the parent UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2718 + + void + + jakarta.faces.component.UIComponent.restoreTransientState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ For components that need to support the concept of transient state, this method will + restore any state saved on a prior call to #saveTransientState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2719 + + Object + + jakarta.faces.component.UIComponent.saveTransientState +
+ ( + FacesContext + ) +
+
+ For components that need to support the concept of transient state, this method will + save any state that is known to be transient in nature. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2720 + + void + + jakarta.faces.component.UIComponent.setId +
+ ( + String + ) +
+
+ Set the component identifier of this UIComponent (if any). Component identifiers must + obey the following syntax restrictions: Must not be a zero-length String. First character must be a + letter or an underscore ('_'). Subsequent characters must be a letter, a digit, an underscore ('_'), + or a dash ('-'). Component identifiers must also obey the following semantic restrictions (note that + this restriction is NOT enforced by the setId() implementation): The specified identifier must be + unique among all the components (including facets) that are descendents of the nearest ancestor + UIComponent that is a NamingContainer, or within the scope of the entire component tree if there is + no such ancestor that is a NamingContainer. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2721 + + void + + jakarta.faces.component.UIComponent.setInView +
+ ( + boolean + ) +
+
+ Updates the status as to whether or not this component is currently within the view + hierarchy. This method must never be called by developers; a UIComponent's internal implementation + will call it as components are added to or removed from a parent's child List or facet Map. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2722 + + void + + jakarta.faces.component.UIComponent.setValueExpression +
+ ( + String + , +
+ ValueExpression + ) +
+
+ Set the ValueExpression used to calculate the value for the specified attribute or + property name, if any. The implementation must call ValueExpression#isLiteralText on the argument + expression. If isLiteralText() returns true, invoke ValueExpression#getValue on the argument + expression and pass the result as the value parameter in a call to this.#getAttributes().put(name, + value) where name is the argument name. If an exception is thrown as a result of calling + ValueExpression#getValue, wrap it in a jakarta.faces.FacesException and re-throw it. If + isLiteralText() returns false, simply store the un-evaluated expression argument in the collection + of ValueExpressions under the key given by the argument name. This method must be overridden and + implemented for components that comply with Jakarta Faces 1.2 and later. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2723 + + void + + jakarta.faces.component.UIComponent.subscribeToEvent +
+ ( + Class + , +
+ ComponentSystemEventListener + ) +
+
+ This implementation throws UnsupportedOperationException and is provided for the sole + purpose of not breaking existing applications that extend this class. UIComponentBase provides the + implementation of this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2724 + + UIComponent + + jakarta.faces.component.UIComponent.UIComponent +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2725 + + void + + jakarta.faces.component.UIComponent.unsubscribeFromEvent +
+ ( + Class + , +
+ ComponentSystemEventListener + ) +
+
+ This implementation throws UnsupportedOperationException and is provided for the sole + purpose of not breaking existing applications that extend this class. UIComponentBase provides the + implementation of this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2726 + + boolean + + jakarta.faces.component.UIComponent.visitTree +
+ ( + VisitContext + , +
+ VisitCallback + ) +
+
+ Perform a tree visit starting at this node in the tree. UIComponent.visitTree() + implementations do not invoke the VisitCallback directly, but instead call + VisitContext#invokeVisitCallback to invoke the callback. This allows VisitContext implementations to + provide optimized tree traversals, for example by only calling the VisitCallback for a subset of + components. UIComponent.visitTree() implementations must call UIComponent.pushComponentToEL() before + performing the visit and UIComponent.popComponentFromEL() after the visit. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2727 + + void + + jakarta.faces.component.UIComponentBase.addClientBehavior +
+ ( + String + , +
+ ClientBehavior + ) +
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#addClientBehavior. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2728 + + void + + jakarta.faces.component.UIComponentBase.broadcast +
+ ( + FacesEvent + ) +
+
+ Broadcast the specified FacesEvent to all registered event listeners who have expressed + an interest in events of this type. Listeners are called in the order in which they were added. If + the event is an instance of jakarta.faces.event.BehaviorEvent and the current component is the + source of the event call jakarta.faces.event.BehaviorEvent#getBehavior to get the + jakarta.faces.component.behavior.Behavior for the event. Call + jakarta.faces.component.behavior.Behavior#broadcast(jakarta.faces.event.BehaviorEvent) on the + Behavior instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2729 + + void + + jakarta.faces.component.UIComponentBase.broadcast +
+ ( + FacesEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ Signal the Jakarta Faces implementation that no further processing on the current event + should be performed + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2730 + + void + + jakarta.faces.component.UIComponentBase.clearInitialState +
+
+
+ For each of the attached objects on this instance that implement PartialStateHolder, + call PartialStateHolder#clearInitialState on the attached object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2731 + + Map + + jakarta.faces.component.UIComponentBase.getAttributes +
+
+
+ Return a mutable Map representing the attributes (and properties, see below) associated + wth this UIComponent, keyed by attribute name (which must be a String). The returned implementation + must support all of the standard and optional Map methods, plus support the following additional + requirements: The Map implementation must implement the java.io.Serializable interface. Any attempt + to add a null key or value must throw a NullPointerException. Any attempt to add a key that is not a + String must throw a ClassCastException. If the attribute name specified as a key matches a property + of this UIComponent's implementation class, the following methods will have special behavior: + containsKey - Return false. get() - If the property is readable, call the getter method and return + the returned value (wrapping primitive values in their corresponding wrapper classes); otherwise + throw IllegalArgumentException. put() - If the property is writeable, call the setter method to set + the corresponding value (unwrapping primitive values in their corresponding wrapper classes). If the + property is not writeable, or an attempt is made to set a property of primitive type to null, throw + IllegalArgumentException. remove - Throw IllegalArgumentException. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2732 + + List + + jakarta.faces.component.UIComponentBase.getChildren +
+
+
+ Return a mutable List representing the child UIComponents associated with this + component. The returned implementation must support all of the standard and optional List methods, + plus support the following additional requirements: The List implementation must implement the + java.io.Serializable interface. Any attempt to add a null must throw a NullPointerException Any + attempt to add an object that does not implement UIComponent must throw a ClassCastException. + Whenever a new child component is added, the parent property of the child must be set to this + component instance. If the parent property of the child was already non-null, the child must first + be removed from its previous parent (where it may have been either a child or a facet). Whenever an + existing child component is removed, the parent property of the child must be set to null. After the + child component has been added to the view, jakarta.faces.application.Application#publishEvent must + be called, passing jakarta.faces.event.PostAddToViewEvent.class as the first argument and the newly + added component as the second argument if any the following cases are true. + jakarta.faces.context.FacesContext#getCurrentPhaseId returns + jakarta.faces.event.PhaseId#RESTORE_VIEW and partial state saving is enabled. + jakarta.faces.context.FacesContext#isPostback returns false and + jakarta.faces.context.FacesContext#getCurrentPhaseId returns something other than + jakarta.faces.event.PhaseId#RESTORE_VIEW + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2733 + + Map + + jakarta.faces.component.UIComponentBase.getClientBehaviors +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getClientBehaviors. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must add an implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2734 + + String + + jakarta.faces.component.UIComponentBase.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2735 + + Collection + + jakarta.faces.component.UIComponentBase.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2736 + + int + + jakarta.faces.component.UIComponentBase.getFacetCount +
+
+
+ Return the number of facet UIComponents that are associated with this UIComponent. If + there are no facets, this method must return 0. The method must not cause the creation of a facet + component map. For backwards compatability with classes that extend UIComponent directly, a default + implementation is provided that simply calls #getFacets and then calls the size() method on the + returned Map. A more optimized version of this method is provided in UIComponentBase#getFacetCount. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2737 + + Map + + jakarta.faces.component.UIComponentBase.getFacets +
+
+
+ Return a mutable Map representing the facet UIComponents associated with this + UIComponent, keyed by facet name (which must be a String). The returned implementation must support + all of the standard and optional Map methods, plus support the following additional requirements: + The Map implementation must implement the java.io.Serializable interface. Any attempt to add a null + key or value must throw a NullPointerException. Any attempt to add a key that is not a String must + throw a ClassCastException. Any attempt to add a value that is not a UIComponent must throw a + ClassCastException. Whenever a new facet UIComponent is added: The parent property of the component + must be set to this component instance. If the parent property of the component was already + non-null, the component must first be removed from its previous parent (where it may have been + either a child or a facet). Whenever an existing facet UIComponent is removed: The parent property + of the facet must be set to null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2738 + + String + + jakarta.faces.component.UIComponentBase.getId +
+
+
+ Return the component identifier of this UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2739 + + List + + jakarta.faces.component.UIComponentBase.getListenersForEventClass +
+ ( + Class + ) +
+
+ Return the SystemEventListener instances registered on this UIComponent instance that + are interested in events of type eventClass. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2740 + + Map + + jakarta.faces.component.UIComponentBase.getPassThroughAttributes +
+ ( + boolean + ) +
+
+ This method has the same specification as #getPassThroughAttributes() except that it is + allowed to return null if and only if the argument create is false and no pass through attribute + data structure exists for this instance. The returned Map implementation must support all of the + standard and optional Map methods, plus support the following additional requirements. The map must + be stored in using #getStateHelper. The Map implementation must implement java.io.Serializable. Any + attempt to add a null key or value must throw a NullPointerException. Any attempt to add a key that + is not a String must throw an IllegalArgumentException. For backward compatibility with components + that extend directly from this class, a default implementation is provided that returns the empty + map. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2741 + + boolean + + jakarta.faces.component.UIComponentBase.invokeOnComponent +
+ ( + FacesContext + , +
+ String + , +
+ ContextCallback + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2742 + + boolean + + jakarta.faces.component.UIComponentBase.invokeOnComponent +
+ ( + FacesContext + , +
+ String + , +
+ ContextCallback + ) + +
+ throws + FacesException +
+
+
+ {@inheritDoc} + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2743 + + boolean + + jakarta.faces.component.UIComponentBase.isTransient +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2744 + + void + + jakarta.faces.component.UIComponentBase.markInitialState +
+
+
+ For each of the attached objects on this instance that implement PartialStateHolder, + call PartialStateHolder#markInitialState on the attached object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2745 + + void + + jakarta.faces.component.UIComponentBase.processRestoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ Perform the component tree processing required by the Restore View phase of the request + processing lifecycle for all facets of this component, all children of this component, and this + component itself, as follows. Call the restoreState() method of this component. Call + UIComponent#pushComponentToEL. Call the processRestoreState() method of all facets and children of + this UIComponent in the order determined by a call to getFacetsAndChildren(). After returning from + the processRestoreState() method on a child or facet, call UIComponent#popComponentFromEL This + method may not be called if the state saving method is set to server. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2746 + + Object + + jakarta.faces.component.UIComponentBase.processSaveState +
+ ( + FacesContext + ) +
+
+ Perform the component tree processing required by the state saving portion of the + Render Response phase of the request processing lifecycle for all facets of this component, all + children of this component, and this component itself, as follows. consult the transient property of + this component. If true, just return null. Call #pushComponentToEL. Call the processSaveState() + method of all facets and children of this UIComponent in the order determined by a call to + getFacetsAndChildren(), skipping children and facets that are transient. Ensure that + #popComponentFromEL is called correctly after each child or facet. Call the saveState() method of + this component. Encapsulate the child state and your state into a Serializable Object and return it. + This method may not be called if the state saving method is set to server. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2747 + + void + + jakarta.faces.component.UIComponentBase.queueEvent +
+ ( + FacesEvent + ) +
+
+ Queue an event for broadcast at the end of the current request processing lifecycle + phase. The default implementation in UIComponentBase must delegate this call to the queueEvent() + method of the parent UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2748 + + Object + + jakarta.faces.component.UIComponentBase.restoreAttachedState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ This method is called by UIComponent subclasses that need to restore the objects they + saved using #saveAttachedState. This method is tightly coupled with #saveAttachedState. This method + supports restoring all attached objects types supported by #saveAttachedState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2749 + + Object + + jakarta.faces.component.UIComponentBase.restoreAttachedState +
+ ( + FacesContext + , +
+ Object + ) + +
+ throws + IllegalStateException +
+
+
+ if the object is not previously returned by #saveAttachedState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2750 + + void + + jakarta.faces.component.UIComponentBase.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2751 + + Object + + jakarta.faces.component.UIComponentBase.saveAttachedState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ This method is called by UIComponent subclasses that want to save one or more attached + objects. It is a convenience method that does the work of saving attached objects that may or may + not implement the StateHolder interface. Using this method implies the use of #restoreAttachedState + to restore the attached objects. This method supports saving attached objects of the following type: + Objects, null values, and Collections of these objects. If any contained objects are not Collections + and do not implement StateHolder, they must have zero-argument public constructors. The exact + structure of the returned object is undefined and opaque, but will be serializable. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2752 + + Object + + jakarta.faces.component.UIComponentBase.saveState +
+ ( + FacesContext + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2753 + + void + + jakarta.faces.component.UIComponentBase.setId +
+ ( + String + ) +
+
+ Set the component identifier of this UIComponent (if any). Component identifiers must + obey the following syntax restrictions: Must not be a zero-length String. First character must be a + letter or an underscore ('_'). Subsequent characters must be a letter, a digit, an underscore ('_'), + or a dash ('-'). Component identifiers must also obey the following semantic restrictions (note that + this restriction is NOT enforced by the setId() implementation): The specified identifier must be + unique among all the components (including facets) that are descendents of the nearest ancestor + UIComponent that is a NamingContainer, or within the scope of the entire component tree if there is + no such ancestor that is a NamingContainer. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2754 + + void + + jakarta.faces.component.UIComponentBase.setTransient +
+ ( + boolean + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2755 + + void + + jakarta.faces.component.UIComponentBase.subscribeToEvent +
+ ( + Class + , +
+ ComponentSystemEventListener + ) +
+
+ Install the listener instance referenced by argument componentListener as a listener + for events of type eventClass originating from this specific instance of UIComponent. The default + implementation creates an inner SystemEventListener instance that wraps argument componentListener + as the listener argument. This inner class must call through to the argument componentListener in + its implementation of SystemEventListener#processEvent and its implementation of + SystemEventListener#isListenerForSource must return true if the instance class of this UIComponent + is assignable from the argument to isListenerForSource. The listener instance referenced by argument + componentListener may not already be installed as a listener for events of type eventClass + originating from this specific instance of UIComponent. When doing the comparison to determine if an + existing listener is equal to the argument componentListener, the equals() method on the existing + listener must be invoked, passing the argument componentListener, rather than the other way around. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2756 + + void + + jakarta.faces.component.UIComponentBase.unsubscribeFromEvent +
+ ( + Class + , +
+ ComponentSystemEventListener + ) +
+
+ Remove the listener instance referenced by argument componentListener as a listener for + events of type eventClass originating from this specific instance of UIComponent. When doing the + comparison to determine if an existing listener is equal to the argument componentListener (and thus + must be removed), the equals() method on the existing listener must be invoked, passing the argument + componentListener, rather than the other way around. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2757 + + void + + jakarta.faces.component.UIData.broadcast +
+ ( + FacesEvent + ) +
+
+ Override the default UIComponentBase#broadcast processing to unwrap any wrapped + FacesEvent and reset the current row index, before the event is actually broadcast. For events that + we did not wrap (in queueEvent()), default processing will occur. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2758 + + void + + jakarta.faces.component.UIData.broadcast +
+ ( + FacesEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ Signal the Jakarta Faces implementation that no further processing on the current event + should be performed + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2759 + + String + + jakarta.faces.component.UIData.createUniqueId +
+ ( + FacesContext + , +
+ String + ) +
+
+ Generate an identifier for a component. The identifier will be prefixed with + UNIQUE_ID_PREFIX, and will be unique within this component-container. Optionally, a unique seed + value can be supplied by component creators which should be included in the generated unique id. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2760 + + void + + jakarta.faces.component.UIData.encodeBegin +
+ ( + FacesContext + ) +
+
+ In addition to the default behavior, ensure that any saved per-row state for our child + input components is discarded unless it is needed to rerender the current page with errors. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2761 + + void + + jakarta.faces.component.UIData.encodeBegin +
+ ( + FacesContext + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs while rendering + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2762 + + String + + jakarta.faces.component.UIData.getClientId +
+ ( + FacesContext + ) +
+
+ Return a client identifier for this component that includes the current value of the + rowIndex property, if it is not set to -1. This implies that multiple calls to getClientId() may + return different results, but ensures that child components can themselves generate row-specific + client identifiers (since UIData is a NamingContainer). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2763 + + String + + jakarta.faces.component.UIData.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2764 + + int + + jakarta.faces.component.UIData.getFirst +
+
+
+ Return the zero-relative row number of the first row to be displayed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2765 + + UIComponent + + jakarta.faces.component.UIData.getFooter +
+
+
+ Return the footer facet of this component (if any). A convenience method for + getFacet("footer"). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2766 + + UIComponent + + jakarta.faces.component.UIData.getHeader +
+
+
+ Return the header facet of this component (if any). A convenience method for + getFacet("header"). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2767 + + int + + jakarta.faces.component.UIData.getRowCount +
+
+
+ Return the number of rows in the underlying data model. If the number of available rows + is unknown, return -1. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2768 + + Object + + jakarta.faces.component.UIData.getRowData +
+
+
+ Return the data object representing the data for the currently selected row index, if + any. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2769 + + int + + jakarta.faces.component.UIData.getRowIndex +
+
+
+ Return the zero-relative index of the currently selected row. If we are not currently + positioned on a row, return -1. This property is not enabled for value binding expressions. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2770 + + int + + jakarta.faces.component.UIData.getRows +
+
+
+ Return the number of rows to be displayed, or zero for all remaining rows in the table. + The default value of this property is zero. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2771 + + Object + + jakarta.faces.component.UIData.getValue +
+
+
+ Return the value of the UIData. This value must either be be of type DataModel, or a + type that can be adapted into a DataModel. UIData will automatically adapt the following types: + Arrays java.util.List java.sql.ResultSet java.util.Collection All other types will be adapted using + the ScalarDataModel class, which will treat the object as a single row of data. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2772 + + String + + jakarta.faces.component.UIData.getVar +
+
+
+ Return the request-scope attribute under which the data object for the current row will + be exposed when iterating. This property is not enabled for value binding expressions. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2773 + + boolean + + jakarta.faces.component.UIData.invokeOnComponent +
+ ( + FacesContext + , +
+ String + , +
+ ContextCallback + ) +
+
+ Override behavior from UIComponentBase#invokeOnComponent to provide special care for + positioning the data properly before finding the component and invoking the callback on it. If the + argument clientId is equal to this.getClientId() simply invoke the contextCallback, passing the + context argument and this as arguments, and return true. If the argument clientId is not equal to + this.getClientId(), inspect each of the facet children of this UIData instance and for each one, + compare its clientId with the argument clientId. If there is a match, invoke the contextCallback, + passing the context argument and this as arguments, and return true. Otherwise, attempt to extract a + rowIndex from the clientId. For example, if the argument clientId was form:data:3:customerHeader the + rowIndex would be 3. Let this value be called newIndex. The current rowIndex of this instance must + be saved aside and restored before returning in all cases, regardless of the outcome of the search + or if any exceptions are thrown in the process. The implementation of this method must never return + true if setting the rowIndex of this instance to be equal to newIndex causes this instance to return + false from #isRowAvailable. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2774 + + boolean + + jakarta.faces.component.UIData.invokeOnComponent +
+ ( + FacesContext + , +
+ String + , +
+ ContextCallback + ) + +
+ throws + FacesException +
+
+
+ {@inheritDoc} Also throws FacesException if any exception is thrown when deriving the + rowIndex from the argument clientId. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2775 + + boolean + + jakarta.faces.component.UIData.isRowAvailable +
+
+
+ Return a flag indicating whether there is rowData available at the current rowIndex. If + no wrappedData is available, return false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2776 + + boolean + + jakarta.faces.component.UIData.isRowStatePreserved +
+
+
+ Return the value of the rowStatePreserved JavaBeans property. See + #setRowStatePreserved. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2777 + + void + + jakarta.faces.component.UIData.markInitialState +
+
+
+ Override the base class method to take special action if the method is being invoked + when StateManager#IS_BUILDING_INITIAL_STATE is true and the rowStatePreserved JavaBeans property for + this instance is true. The additional action taken is to traverse the descendents and save their + state without regard to any particular row value. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2778 + + void + + jakarta.faces.component.UIData.processDecodes +
+ ( + FacesContext + ) +
+
+ Override the default UIComponentBase#processDecodes processing to perform the following + steps. If the rendered property of this UIComponent is false, skip further processing. Set the + current rowIndex to -1. Call the processDecodes() method of all facets of this UIData, in the order + determined by a call to getFacets().keySet().iterator(). Call the processDecodes() method of all + facets of the UIColumn children of this UIData. Iterate over the set of rows that were included when + this component was rendered (i.e. those defined by the first and rows properties), performing the + following processing for each row: Set the current rowIndex to the appropriate value for this row. + If isRowAvailable() returns true, iterate over the children components of each UIColumn child of + this UIData component, calling the processDecodes() method for each such child. Set the current + rowIndex to -1. Call the decode() method of this component. If a RuntimeException is thrown during + decode processing, call FacesContext#renderResponse and re-throw the exception. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2779 + + void + + jakarta.faces.component.UIData.processUpdates +
+ ( + FacesContext + ) +
+
+ Override the default UIComponentBase#processUpdates processing to perform the following + steps. If the rendered property of this UIComponent is false, skip further processing. Set the + current rowIndex to -1. Call the processUpdates() method of all facets of this UIData, in the order + determined by a call to getFacets().keySet().iterator(). Call the processUpdates() method of all + facets of the UIColumn children of this UIData. Iterate over the set of rows that were included when + this component was rendered (i.e. those defined by the first and rows properties), performing the + following processing for each row: Set the current rowIndex to the appropriate value for this row. + If isRowAvailable() returns true, iterate over the children components of each UIColumn child of + this UIData component, calling the processUpdates() method for each such child. Set the current + rowIndex to -1. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2780 + + void + + jakarta.faces.component.UIData.processValidators +
+ ( + FacesContext + ) +
+
+ Override the default UIComponentBase#processValidators processing to perform the + following steps. If the rendered property of this UIComponent is false, skip further processing. Set + the current rowIndex to -1. Call the processValidators() method of all facets of this UIData, in the + order determined by a call to getFacets().keySet().iterator(). Call the processValidators() method + of all facets of the UIColumn children of this UIData. Iterate over the set of rows that were + included when this component was rendered (i.e. those defined by the first and rows properties), + performing the following processing for each row: Set the current rowIndex to the appropriate value + for this row. If isRowAvailable() returns true, iterate over the children components of each + UIColumn child of this UIData component, calling the processValidators() method for each such child. + Set the current rowIndex to -1. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2781 + + void + + jakarta.faces.component.UIData.queueEvent +
+ ( + FacesEvent + ) +
+
+ Override the default UIComponentBase#queueEvent processing to wrap any queued events in + a wrapper so that we can reset the current row index in broadcast(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2782 + + void + + jakarta.faces.component.UIData.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2783 + + Object + + jakarta.faces.component.UIData.saveState +
+ ( + FacesContext + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2784 + + void + + jakarta.faces.component.UIData.setFirst +
+ ( + int + ) +
+
+ Set the zero-relative row number of the first row to be displayed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2785 + + void + + jakarta.faces.component.UIData.setFooter +
+ ( + UIComponent + ) +
+
+ Set the footer facet of this component. A convenience method for + getFacets().put("footer", footer). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2786 + + void + + jakarta.faces.component.UIData.setHeader +
+ ( + UIComponent + ) +
+
+ Set the header facet of this component. A convenience method for + getFacets().put("header", header). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2787 + + void + + jakarta.faces.component.UIData.setRowIndex +
+ ( + int + ) +
+
+ Set the zero relative index of the current row, or -1 to indicate that no row is + currently selected, by implementing the following algorithm. It is possible to set the row index at + a value for which the underlying data collection does not contain any row data. Therefore, callers + may use the isRowAvailable() method to detect whether row data will be available for use by the + getRowData() method. To support transient state among descendents, please consult the specification + for #setRowStatePreserved, which details the requirements for setRowIndex() when the + rowStatePreserved JavaBeans property is set to true. Save current state information for all + descendant components (as described below). Store the new row index, and pass it on to the DataModel + associated with this UIData instance. If the new rowIndex value is -1: If the var property is not + null, remove the corresponding request scope attribute (if any). Reset the state information for all + descendant components (as described below). If the new rowIndex value is not -1: If the var property + is not null, call getRowData() and expose the resulting data object as a request scope attribute + whose key is the var property value. Reset the state information for all descendant components (as + described below). To save current state information for all descendant components, UIData must + maintain per-row information for each descendant as follows: If the descendant is an instance of + EditableValueHolder, save the state of its localValue property. If the descendant is an instance of + EditableValueHolder, save the state of the localValueSet property. If the descendant is an instance + of EditableValueHolder, save the state of the valid property. If the descendant is an instance of + EditableValueHolder, save the state of the submittedValue property. To restore current state + information for all descendant components, UIData must reference its previously stored information + for the current rowIndex and call setters for each descendant as follows: If the descendant is an + instance of EditableValueHolder, restore the value property. If the descendant is an instance of + EditableValueHolder, restore the state of the localValueSet property. If the descendant is an + instance of EditableValueHolder, restore the state of the valid property. If the descendant is an + instance of EditableValueHolder, restore the state of the submittedValue property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2788 + + void + + jakarta.faces.component.UIData.setRows +
+ ( + int + ) +
+
+ Set the number of rows to be displayed, or zero for all remaining rows in the table. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2789 + + void + + jakarta.faces.component.UIData.setRowStatePreserved +
+ ( + boolean + ) +
+
+ If this property is set to true, the UIData must take steps to ensure that + modifications to its iterated children will be preserved on a per-row basis. This allows + applications to modify component properties, such as the style-class, for a specific row, rather + than having such modifications apply to all rows. To accomplish this, UIData must call + StateHolder#saveState and TransientStateHolder#saveTransientState on its children to capture their + state on exiting each row. When re-entering the row, StateHolder#restoreState and + TransientStateHolder#restoreTransientState must be called in order to reinitialize the children to + the correct state for the new row. All of this action must take place during the processing of + #setRowIndex. Users should consider enabling this feature for cases where it is necessary to modify + properties of UIData's children in a row-specific way. Note, however, that row-level state + saving/restoring does add overhead. As such, this feature should be used judiciously. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2790 + + void + + jakarta.faces.component.UIData.setValue +
+ ( + Object + ) +
+
+ Set the value of the UIData. This value must either be be of type DataModel, or a type + that can be adapted into a DataModel. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2791 + + void + + jakarta.faces.component.UIData.setValueExpression +
+ ( + String + , +
+ ValueExpression + ) +
+
+ Set the ValueExpression used to calculate the value for the specified attribute or + property name, if any. In addition, if a ValueExpression is set for the value property, remove any + synthesized DataModel for the data previously bound to this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2792 + + void + + jakarta.faces.component.UIData.setVar +
+ ( + String + ) +
+
+ Set the request-scope attribute under which the data object for the current row wil be + exposed when iterating. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2793 + + UIData + + jakarta.faces.component.UIData.UIData +
+
+
+ Create a new UIData instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2794 + + boolean + + jakarta.faces.component.UIData.visitTree +
+ ( + VisitContext + , +
+ VisitCallback + ) +
+
+ Override the behavior in UIComponent#visitTree to handle iteration correctly. If the + UIComponent#isVisitable method of this instance returns false, take no action and return. Call + UIComponent#pushComponentToEL and invoke the visit callback on this UIData instance as described in + UIComponent#visitTree. Let the result of the invoctaion be visitResult. If visitResult is + VisitResult#COMPLETE, take no further action and return true. Otherwise, determine if we need to + visit our children. The default implementation calls VisitContext#getSubtreeIdsToVisit passing this + as the argument. If the result of that call is non-empty, let doVisitChildren be true. If + doVisitChildren is true and visitResult is VisitResult#ACCEPT, take the following action. If this + component has facets, call UIComponent#getFacets on this instance and invoke the values() method. + For each UIComponent in the returned Map, call UIComponent#visitTree. If this component has + children, for each UIColumn child: Call VisitContext#invokeVisitCallback on that UIColumn instance. + If such a call returns true, terminate visiting and return true from this method. If the child + UIColumn has facets, call UIComponent#visitTree on each one. Take no action on non-UIColumn + children. Save aside the result of a call to #getRowIndex. For each child component of this UIData + that is also an instance of UIColumn, Iterate over the rows. Let rowsToProcess be the return from + #getRows. Let rowIndex be the return from #getFirst - 1. While the number of rows processed is less + than rowsToProcess, take the following actions. Call #setRowIndex, passing the current row index. If + #isRowAvailable returns false, take no further action and return false. Call UIComponent#visitTree + on each of the children of this UIColumn instance. Call #popComponentFromEL and restore the saved + row index with a call to #setRowIndex. Return false to allow the visiting to continue. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2795 + + String + + jakarta.faces.component.UIForm.createUniqueId +
+ ( + FacesContext + , +
+ String + ) +
+
+ Generate an identifier for a component. The identifier will be prefixed with + UNIQUE_ID_PREFIX, and will be unique within this component-container. Optionally, a unique seed + value can be supplied by component creators which should be included in the generated unique id. If + the prependId property has the value false, this method must call createUniqueId on the next + ancestor UniqueIdVendor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2796 + + String + + jakarta.faces.component.UIForm.getContainerClientId +
+ ( + FacesContext + ) +
+
+ Override the UIComponent#getContainerClientId to allow users to disable this form from + prepending its clientId to its descendent's clientIds depending on the value of this form's + #isPrependId property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2797 + + String + + jakarta.faces.component.UIForm.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2798 + + boolean + + jakarta.faces.component.UIForm.isPrependId +
+
+
+ Is the id prepended. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2799 + + boolean + + jakarta.faces.component.UIForm.isSubmitted +
+
+
+ Returns the current value of the submitted property. The default value is false. See + #setSubmitted for details. This property must be kept as a transient property using the + UIComponent#getTransientStateHelper. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2800 + + void + + jakarta.faces.component.UIForm.processDecodes +
+ ( + FacesContext + ) +
+
+ Override UIComponent#processDecodes to ensure that the form is decoded before its + children. This is necessary to allow the submitted property to be correctly set. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2801 + + void + + jakarta.faces.component.UIForm.processUpdates +
+ ( + FacesContext + ) +
+
+ Override UIComponent#processUpdates to ensure that the children of this UIForm instance + are only processed if #isSubmitted returns true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2802 + + void + + jakarta.faces.component.UIForm.processValidators +
+ ( + FacesContext + ) +
+
+ Override UIComponent#processValidators to ensure that the children of this UIForm + instance are only processed if #isSubmitted returns true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2803 + + void + + jakarta.faces.component.UIForm.setPrependId +
+ ( + boolean + ) +
+
+ Set whether the id should be prepended. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2804 + + void + + jakarta.faces.component.UIForm.setSubmitted +
+ ( + boolean + ) +
+
+ If this UIForm instance (as opposed to other forms in the page) is experiencing a + submit during this request processing lifecycle, this method must be called, with true as the + argument, during the UIComponent#decode for this UIForm instance. If this UIForm instance is not + experiencing a submit, this method must be called, with false as the argument, during the + UIComponent#decode for this UIForm instance. The value of a UIForm's submitted property must not be + saved as part of its state. This property must be kept as a transient property using the + UIComponent#getTransientStateHelper. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2805 + + boolean + + jakarta.faces.component.UIForm.visitTree +
+ ( + VisitContext + , +
+ VisitCallback + ) +
+
+ Perform a tree visit starting at this node in the tree. UIComponent.visitTree() + implementations do not invoke the VisitCallback directly, but instead call + VisitContext#invokeVisitCallback to invoke the callback. This allows VisitContext implementations to + provide optimized tree traversals, for example by only calling the VisitCallback for a subset of + components. UIComponent.visitTree() implementations must call UIComponent.pushComponentToEL() before + performing the visit and UIComponent.popComponentFromEL() after the visit. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2806 + + String + + jakarta.faces.component.UIGraphic.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2807 + + String + + jakarta.faces.component.UIGraphic.getUrl +
+
+
+ Return the image URL for this UIGraphic. This method is a typesafe alias for + getValue(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2808 + + Object + + jakarta.faces.component.UIGraphic.getValue +
+
+
+ Returns the value property of the UIGraphic. This will typically be rendered as an URL. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2809 + + ValueExpression + + jakarta.faces.component.UIGraphic.getValueExpression +
+ ( + String + ) +
+
+ Return any ValueExpression set for value if a ValueExpression for url is requested; + otherwise, perform the default superclass processing for this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2810 + + void + + jakarta.faces.component.UIGraphic.setUrl +
+ ( + String + ) +
+
+ Set the image URL for this UIGraphic. This method is a typesafe alias for setValue(). + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2811 + + void + + jakarta.faces.component.UIGraphic.setValue +
+ ( + Object + ) +
+
+ Sets the value property of the UIGraphic. This will typically be rendered as an URL. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2812 + + void + + jakarta.faces.component.UIGraphic.setValueExpression +
+ ( + String + , +
+ ValueExpression + ) +
+
+ Store any ValueExpression specified for url under value instead; otherwise, perform the + default superclass processing for this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2813 + + String + + jakarta.faces.component.UIImportConstants.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2814 + + String + + jakarta.faces.component.UIImportConstants.getType +
+
+
+ Returns the fully qualified name of the type to import the constant field values for. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2815 + + String + + jakarta.faces.component.UIImportConstants.getVar +
+
+
+ Returns name of request scope attribute under which constants will be exposed as a Map. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2816 + + void + + jakarta.faces.component.UIImportConstants.setType +
+ ( + String + ) +
+
+ Sets the fully qualified name of the type to import the constant field values for. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2817 + + void + + jakarta.faces.component.UIImportConstants.setValueExpression +
+ ( + String + , +
+ ValueExpression + ) +
+
+ Set the ValueExpression used to calculate the value for the specified attribute or + property name, if any. If a ValueExpression is set for the var property, throw an illegal argument + exception. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2818 + + void + + jakarta.faces.component.UIImportConstants.setVar +
+ ( + String + ) +
+
+ Sets name of request scope attribute under which constants will be exposed as a Map. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2819 + + UIImportConstants + + jakarta.faces.component.UIImportConstants.UIImportConstants +
+
+
+ Create a new UIImportConstants instance with renderer type set to null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2820 + + void + + jakarta.faces.component.UIInput.addValidator +
+ ( + Validator + ) +
+
+ Add a Validator instance to the set associated with this UIInput. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2821 + + void + + jakarta.faces.component.UIInput.addValueChangeListener +
+ ( + ValueChangeListener + ) +
+
+ Add a new ValueChangeListener to the set of listeners interested in being notified when + ValueChangeEvents occur. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2822 + + void + + jakarta.faces.component.UIInput.clearInitialState +
+
+
+ For each of the attached objects on this instance that implement PartialStateHolder, + call PartialStateHolder#clearInitialState on the attached object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2823 + + void + + jakarta.faces.component.UIInput.decode +
+ ( + FacesContext + ) +
+
+ Decode any new state of this UIComponent from the request contained in the specified + FacesContext, and store this state as needed. During decoding, events may be enqueued for later + processing (by event listeners who have registered an interest), by calling queueEvent(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2824 + + String + + jakarta.faces.component.UIInput.getConverterMessage +
+
+
+ If there has been a call to #setConverterMessage on this instance, return the message. + Otherwise, call #getValueExpression passing the key "converterMessage", get the result of the + expression, and return it. Any ELExceptions thrown during the call to getValue() must be wrapped in + a FacesException and rethrown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2825 + + String + + jakarta.faces.component.UIInput.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2826 + + String + + jakarta.faces.component.UIInput.getRequiredMessage +
+
+
+ If there has been a call to #setRequiredMessage on this instance, return the message. + Otherwise, call #getValueExpression passing the key "requiredMessage", get the result of the + expression, and return it. Any ELExceptions thrown during the call to getValue() must be wrapped in + a FacesException and rethrown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2827 + + Object + + jakarta.faces.component.UIInput.getSubmittedValue +
+
+
+ Return the submittedValue value of this UIInput component. This method should only be + used by the decode() and validate() method of this component, or its corresponding Renderer. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2828 + + String + + jakarta.faces.component.UIInput.getValidatorMessage +
+
+
+ If there has been a call to #setValidatorMessage on this instance, return the message. + Otherwise, call #getValueExpression passing the key "validatorMessage", get the result of the + expression, and return it. Any ELExceptions thrown during the call to getValue() must be wrapped in + a FacesException and rethrown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2829 + + Validator[] + + jakarta.faces.component.UIInput.getValidators +
+
+
+ Return the set of registered Validators for this UIInput instance. If there are no + registered validators, a zero-length array is returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2830 + + Object + + jakarta.faces.component.UIInput.getValue +
+
+
+ If there is a local value, return it, otherwise return the result of calling + super.getVaue(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2831 + + ValueChangeListener[] + + jakarta.faces.component.UIInput.getValueChangeListeners +
+
+
+ Return the set of registered ValueChangeListeners for this UIInput instance. If there + are no registered listeners, a zero-length array is returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2832 + + boolean + + jakarta.faces.component.UIInput.isEmpty +
+ ( + Object + ) +
+
+ Is the value denoting an empty value. If the value is null, return true. If the value + is a String and it is the empty string, return true. If the value is an array and the array length + is 0, return true. If the value is a List and the List is empty, return true. If the value is a + Collection and the Collection is empty, return true. If the value is a Map and the Map is empty, + return true. In all other cases, return false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2833 + + boolean + + jakarta.faces.component.UIInput.isImmediate +
+
+
+ Return the "immediate" state for this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2834 + + boolean + + jakarta.faces.component.UIInput.isLocalValueSet +
+
+
+ Return the "local value set" state for this component. Calls to setValue() + automatically reset this property to true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2835 + + boolean + + jakarta.faces.component.UIInput.isRequired +
+
+
+ Return the "required field" state for this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2836 + + boolean + + jakarta.faces.component.UIInput.isValid +
+
+
+ Return a flag indicating whether the local value of this component is valid (no + conversion error has occurred). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2837 + + void + + jakarta.faces.component.UIInput.markInitialState +
+
+
+ In addition to the actions taken in UIOutput when PartialStateHolder#markInitialState() + is called, check if any of the installed Validators are PartialStateHolders and if so, call + jakarta.faces.component.PartialStateHolder#markInitialState() as appropriate. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2838 + + void + + jakarta.faces.component.UIInput.processDecodes +
+ ( + FacesContext + ) +
+
+ Specialized decode behavior on top of that provided by the superclass. In addition to + the standard processDecodes behavior inherited from UIComponentBase, calls validate() if the the + immediate property is true; if the component is invalid afterwards or a RuntimeException is thrown, + calls FacesContext#renderResponse. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2839 + + void + + jakarta.faces.component.UIInput.processUpdates +
+ ( + FacesContext + ) +
+
+ In addition to the standard processUpdates behavior inherited from UIComponentBase, + calls updateModel(). If the component is invalid afterwards, calls FacesContext#renderResponse. If a + RuntimeException is thrown during update processing, calls FacesContext#renderResponse and re-throw + the exception. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2840 + + void + + jakarta.faces.component.UIInput.processValidators +
+ ( + FacesContext + ) +
+
+ In addition to the standard processValidators behavior inherited from UIComponentBase, + calls validate() if the immediate property is false (which is the default); if the component is + invalid afterwards, calls FacesContext#renderResponse. To ensure the PostValidateEvent is published + at the proper time, this component must be validated first, followed by the component's children and + facets. If a RuntimeException is thrown during validation processing, calls + FacesContext#renderResponse and re-throw the exception. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2841 + + void + + jakarta.faces.component.UIInput.removeValidator +
+ ( + Validator + ) +
+
+ Remove a Validator instance from the set associated with this UIInput, if it was + previously associated. Otherwise, do nothing. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2842 + + void + + jakarta.faces.component.UIInput.removeValueChangeListener +
+ ( + ValueChangeListener + ) +
+
+ Remove an existing ValueChangeListener (if any) from the set of listeners interested in + being notified when ValueChangeEvents occur. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2843 + + void + + jakarta.faces.component.UIInput.resetValue +
+
+
+ Convenience method to reset this component's value to the un-initialized state. This + method does the following: Call UIOutput#setValue. Call #setSubmittedValue passing null. Clear state + for property localValueSet. Clear state for property valid. Upon return from this call if the + instance had a ValueBinding associated with it for the "value" property, this binding is evaluated + when UIOutput#getValue is called. Otherwise, null is returned from getValue(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2844 + + void + + jakarta.faces.component.UIInput.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2845 + + Object + + jakarta.faces.component.UIInput.saveState +
+ ( + FacesContext + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2846 + + void + + jakarta.faces.component.UIInput.setConverterMessage +
+ ( + String + ) +
+
+ Override any ValueExpression set for the "converterMessage" with the literal argument + provided to this method. Subsequent calls to #getConverterMessage will return this value; + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2847 + + void + + jakarta.faces.component.UIInput.setImmediate +
+ ( + boolean + ) +
+
+ Set the "immediate" state for this component. When set to true, the component's value + will be converted and validated immediately in the Apply Request Values phase, and ValueChangeEvents + will be delivered in that phase as well. The default value for this property must be false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2848 + + void + + jakarta.faces.component.UIInput.setLocalValueSet +
+ ( + boolean + ) +
+
+ Sets the "local value set" state for this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2849 + + void + + jakarta.faces.component.UIInput.setRequired +
+ ( + boolean + ) +
+
+ Set the "required field" state for this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2850 + + void + + jakarta.faces.component.UIInput.setRequiredMessage +
+ ( + String + ) +
+
+ Override any ValueExpression set for the "requiredMessage" with the literal argument + provided to this method. Subsequent calls to #getRequiredMessage will return this value; + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2851 + + void + + jakarta.faces.component.UIInput.setSubmittedValue +
+ ( + Object + ) +
+
+ Set the submittedValue value of this UIInput component. This method should only be used + by the decode() and validate() method of this component, or its corresponding Renderer. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2852 + + void + + jakarta.faces.component.UIInput.setValid +
+ ( + boolean + ) +
+
+ Set a flag indicating whether the local value of this component is valid (no conversion + error has occurred). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2853 + + void + + jakarta.faces.component.UIInput.setValidatorMessage +
+ ( + String + ) +
+
+ Override any ValueExpression set for the "validatorMessage" with the literal argument + provided to this method. Subsequent calls to #getValidatorMessage will return this value; + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2854 + + void + + jakarta.faces.component.UIInput.setValue +
+ ( + Object + ) +
+
+ Set the value of this UIComponent (if any). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2855 + + String + + jakarta.faces.component.UIMessage.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2856 + + String + + jakarta.faces.component.UIMessage.getFor +
+
+
+ Return the Identifier of the component for which to render error messages. If this + component is within the same NamingContainer as the target component, this must be the component + identifier. Otherwise, it must be an absolute component identifier (starting with ":"). See the + UIComponent#findComponent for more information. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2857 + + boolean + + jakarta.faces.component.UIMessage.isRedisplay +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2858 + + boolean + + jakarta.faces.component.UIMessage.isShowDetail +
+
+
+ Return the flag indicating whether the detail property of the associated message(s) + should be displayed. Defaults to true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2859 + + boolean + + jakarta.faces.component.UIMessage.isShowSummary +
+
+
+ Return the flag indicating whether the summary property of the associated message(s) + should be displayed. Defaults to false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2860 + + void + + jakarta.faces.component.UIMessage.setFor +
+ ( + String + ) +
+
+ Set the identifier of the component for which this component represents associated + message(s) (if any). This property must be set before the message is displayed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2861 + + void + + jakarta.faces.component.UIMessage.setRedisplay +
+ ( + boolean + ) +
+
+ Set the flag indicating whether the detail property of the associated message(s) should + be displayed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2862 + + void + + jakarta.faces.component.UIMessage.setShowDetail +
+ ( + boolean + ) +
+
+ Set the flag indicating whether the detail property of the associated message(s) should + be displayed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2863 + + void + + jakarta.faces.component.UIMessage.setShowSummary +
+ ( + boolean + ) +
+
+ Set the flag indicating whether the summary property of the associated message(s) + should be displayed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2864 + + UIMessage + + jakarta.faces.component.UIMessage.UIMessage +
+
+
+ Create a new UIMessage instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2865 + + String + + jakarta.faces.component.UIMessages.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2866 + + String + + jakarta.faces.component.UIMessages.getFor +
+
+
+ Return the client identifier of the component for which this component represents + associated message(s) (if any). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2867 + + boolean + + jakarta.faces.component.UIMessages.isGlobalOnly +
+
+
+ Return the flag indicating whether only global messages (that is, messages with no + associated client identifier) should be rendered. Mutually exclusive with the "for" property which + takes precedence. Defaults to false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2868 + + boolean + + jakarta.faces.component.UIMessages.isRedisplay +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2869 + + boolean + + jakarta.faces.component.UIMessages.isShowDetail +
+
+
+ Return the flag indicating whether the detail property of the associated message(s) + should be displayed. Defaults to false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2870 + + boolean + + jakarta.faces.component.UIMessages.isShowSummary +
+
+
+ Return the flag indicating whether the summary property of the associated message(s) + should be displayed. Defaults to true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2871 + + void + + jakarta.faces.component.UIMessages.setFor +
+ ( + String + ) +
+
+ Set the client identifier of the component for which this component represents + associated message(s) (if any). This property must be set before the message is displayed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2872 + + void + + jakarta.faces.component.UIMessages.setGlobalOnly +
+ ( + boolean + ) +
+
+ Set the flag indicating whether only global messages (that is, messages with no + associated client identifier) should be rendered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2873 + + void + + jakarta.faces.component.UIMessages.setRedisplay +
+ ( + boolean + ) +
+
+ Set the flag indicating whether the detail property of the associated message(s) should + be displayed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2874 + + void + + jakarta.faces.component.UIMessages.setShowDetail +
+ ( + boolean + ) +
+
+ Set the flag indicating whether the detail property of the associated message(s) should + be displayed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2875 + + void + + jakarta.faces.component.UIMessages.setShowSummary +
+ ( + boolean + ) +
+
+ Set the flag indicating whether the summary property of the associated message(s) + should be displayed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2876 + + UIMessages + + jakarta.faces.component.UIMessages.UIMessages +
+
+
+ Create a new UIMessages instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2877 + + String + + jakarta.faces.component.UINamingContainer.createUniqueId +
+ ( + FacesContext + , +
+ String + ) +
+
+ Generate an identifier for a component. The identifier will be prefixed with + UNIQUE_ID_PREFIX, and will be unique within this component-container. Optionally, a unique seed + value can be supplied by component creators which should be included in the generated unique id. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2878 + + String + + jakarta.faces.component.UINamingContainer.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2879 + + char + + jakarta.faces.component.UINamingContainer.getSeparatorChar +
+ ( + FacesContext + ) +
+
+ Return the character used to separate segments of a clientId. The implementation must + determine if there is a with the value given by the value of the symbolic constant + #SEPARATOR_CHAR_PARAM_NAME. If there is a value for this param, the first character of the value + must be returned from this method. Otherwise, the value of the symbolic constant + NamingContainer#SEPARATOR_CHAR must be returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2880 + + boolean + + jakarta.faces.component.UINamingContainer.visitTree +
+ ( + VisitContext + , +
+ VisitCallback + ) +
+
+ Perform a tree visit starting at this node in the tree. UIComponent.visitTree() + implementations do not invoke the VisitCallback directly, but instead call + VisitContext#invokeVisitCallback to invoke the callback. This allows VisitContext implementations to + provide optimized tree traversals, for example by only calling the VisitCallback for a subset of + components. UIComponent.visitTree() implementations must call UIComponent.pushComponentToEL() before + performing the visit and UIComponent.popComponentFromEL() after the visit. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2881 + + String + + jakarta.faces.component.UIOutcomeTarget.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2882 + + String + + jakarta.faces.component.UIOutcomeTarget.getOutcome +
+
+
+ Returns the outcome property of the UIOutcomeTarget. This value is passed to the + jakarta.faces.application.NavigationHandler when resolving the target url of this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2883 + + boolean + + jakarta.faces.component.UIOutcomeTarget.isDisableClientWindow +
+
+
+ Return whether or not the client window should be encoded into the target url. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2884 + + boolean + + jakarta.faces.component.UIOutcomeTarget.isIncludeViewParams +
+
+
+ Return whether or not the view parameters should be encoded into the target url. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2885 + + void + + jakarta.faces.component.UIOutcomeTarget.setDisableClientWindow +
+ ( + boolean + ) +
+
+ Set whether or not the client window should be encoded into the target url. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2886 + + void + + jakarta.faces.component.UIOutcomeTarget.setIncludeViewParams +
+ ( + boolean + ) +
+
+ Set whether or not the page parameters should be encoded into the target url. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2887 + + void + + jakarta.faces.component.UIOutcomeTarget.setOutcome +
+ ( + String + ) +
+
+ Sets the outcome property of the UIOutcomeTarget. This value is passed to the + NavigationHandler when resolving the target url of this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2888 + + UIOutcomeTarget + + jakarta.faces.component.UIOutcomeTarget.UIOutcomeTarget +
+
+
+ Create a new UIOutcomeTarget instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2889 + + void + + jakarta.faces.component.UIOutput.clearInitialState +
+
+
+ For each of the attached objects on this instance that implement PartialStateHolder, + call PartialStateHolder#clearInitialState on the attached object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2890 + + Converter + + jakarta.faces.component.UIOutput.getConverter +
+
+
+ Return the Converter (if any) that is registered for this UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2891 + + String + + jakarta.faces.component.UIOutput.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2892 + + Object + + jakarta.faces.component.UIOutput.getLocalValue +
+
+
+ Return the local value of this UIComponent (if any), without evaluating any associated + ValueExpression. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2893 + + void + + jakarta.faces.component.UIOutput.markInitialState +
+
+
+ In addition to the actions taken in UIComponentBase when + PartialStateHolder#markInitialState() is called, check if the installed Converter is a + PartialStateHolder and if it is, call jakarta.faces.component.PartialStateHolder#markInitialState() + on it. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2894 + + void + + jakarta.faces.component.UIOutput.resetValue +
+
+
+ Convenience method to reset this component's value to the un-initialized state. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2895 + + void + + jakarta.faces.component.UIOutput.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2896 + + Object + + jakarta.faces.component.UIOutput.saveState +
+ ( + FacesContext + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2897 + + void + + jakarta.faces.component.UIOutput.setConverter +
+ ( + Converter + ) +
+
+ Set the Converter (if any) that is registered for this UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2898 + + String + + jakarta.faces.component.UIPanel.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2899 + + String + + jakarta.faces.component.UIParameter.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2900 + + Object + + jakarta.faces.component.UIParameter.getValue +
+
+
+ Returns the value property of the UIParameter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2901 + + boolean + + jakarta.faces.component.UIParameter.isDisable +
+
+
+ Return the value of the disable directive for this component. This directive determines + whether the parameter value should be disabled by assigning it a null value. If true, the value set + on this component is ignored. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2902 + + void + + jakarta.faces.component.UIParameter.setDisable +
+ ( + boolean + ) +
+
+ Sets the disable property of the UIParameter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2903 + + void + + jakarta.faces.component.UIParameter.setValue +
+ ( + Object + ) +
+
+ Sets the value property of the\ UIParameter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2904 + + String + + jakarta.faces.component.UISelectBoolean.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2905 + + ValueExpression + + jakarta.faces.component.UISelectBoolean.getValueExpression +
+ ( + String + ) +
+
+ Return any ValueExpression set for value if a ValueExpression for selected is + requested; otherwise, perform the default superclass processing for this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2906 + + void + + jakarta.faces.component.UISelectBoolean.setValueExpression +
+ ( + String + , +
+ ValueExpression + ) +
+
+ Store any ValueExpression specified for selected under value instead; otherwise, + perform the default superclass processing for this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2907 + + String + + jakarta.faces.component.UISelectItem.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2908 + + Object + + jakarta.faces.component.UISelectItem.getItemValue +
+
+
+ Return the server value for this selection item. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2909 + + Object + + jakarta.faces.component.UISelectItem.getValue +
+
+
+ Returns the value property of the UISelectItem. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2910 + + boolean + + jakarta.faces.component.UISelectItem.isItemDisabled +
+
+
+ Return the disabled setting for this selection item. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2911 + + boolean + + jakarta.faces.component.UISelectItem.isItemEscaped +
+
+
+ Return the escape setting for the label of this selection item. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2912 + + boolean + + jakarta.faces.component.UISelectItem.isNoSelectionOption +
+
+
+ Return the value of the noSelectionOption property. If the value of this property is + true, the system interprets the option represented by this UISelectItem instance as representing a + "no selection" option. See UISelectOne#validateValue and UISelectMany#validateValue for usage. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2913 + + void + + jakarta.faces.component.UISelectItem.setItemDisabled +
+ ( + boolean + ) +
+
+ Set the disabled value for this selection item. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2914 + + void + + jakarta.faces.component.UISelectItem.setItemEscaped +
+ ( + boolean + ) +
+
+ Set the escape value for the label of this selection item. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2915 + + void + + jakarta.faces.component.UISelectItem.setItemValue +
+ ( + Object + ) +
+
+ Set the server value for this selection item. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2916 + + void + + jakarta.faces.component.UISelectItem.setNoSelectionOption +
+ ( + boolean + ) +
+
+ Set the value of the noSelectionOption property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2917 + + void + + jakarta.faces.component.UISelectItem.setValue +
+ ( + Object + ) +
+
+ Sets the value property of the UISelectItem. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2918 + + Object + + jakarta.faces.component.UISelectItemGroup.getValue +
+
+
+ Return a new SelectItemGroup instance containing one or more SelectItem instances + represented by any nested UISelectItems or UISelectItem components. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2919 + + UISelectItemGroup + + jakarta.faces.component.UISelectItemGroup.UISelectItemGroup +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2920 + + Object + + jakarta.faces.component.UISelectItemGroups.getValue +
+
+
+ Iterate over the value attribute and wrap each item in a new SelectItemGroup instance + whereby the item is exposed as a request attribute under the key specified by the var property. This + must allow any nested UISelectItems or UISelectItem component to access the item via their + attributes. Finally return these SelectItemGroup instances as an ordered collection. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2921 + + UISelectItemGroups + + jakarta.faces.component.UISelectItemGroups.UISelectItemGroups +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2922 + + String + + jakarta.faces.component.UISelectItems.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2923 + + Object + + jakarta.faces.component.UISelectItems.getValue +
+
+
+ Returns the value property of the UISelectItems. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2924 + + void + + jakarta.faces.component.UISelectItems.setValue +
+ ( + Object + ) +
+
+ Sets the value property of the UISelectItems. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2925 + + void + + jakarta.faces.component.UISelectItems.setValueExpression +
+ ( + String + , +
+ ValueExpression + ) +
+
+ Set the ValueExpression used to calculate the value for the specified attribute or + property name, if any. In addition, if a ValueExpression is set for the var property, regardless of + the value, throw an illegal argument exception. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2926 + + String + + jakarta.faces.component.UISelectMany.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2927 + + ValueExpression + + jakarta.faces.component.UISelectMany.getValueExpression +
+ ( + String + ) +
+
+ Return any ValueExpression set for value if a ValueExpression for selectedValues is + requested; otherwise, perform the default superclass processing for this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2928 + + void + + jakarta.faces.component.UISelectMany.setValueExpression +
+ ( + String + , +
+ ValueExpression + ) +
+
+ Store any ValueExpression specified for selectedValues under value instead; otherwise, + perform the default superclass processing for this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2929 + + String + + jakarta.faces.component.UISelectOne.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2930 + + String + + jakarta.faces.component.UISelectOne.getGroup +
+
+
+ Returns the name of the radio button group. Radio button components having the same + group within a UIForm parent will uncheck all others when being checked. If the value attribute is + absent then the one from first component of the group will be used. If the UISelectItem child is + absent then the one from first component of the group will be used. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2931 + + void + + jakarta.faces.component.UISelectOne.processValidators +
+ ( + FacesContext + ) +
+
+ If #getGroup() is set, and #getSubmittedValue() is empty, and at least one other + component having the same group within a UIForm parent has a non-empty #getSubmittedValue() or + returns true on #isLocalValueSet() or returns false on #isValid(), then skip validation for current + component, else perform standard superclass processing by super.processValidators(context). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2932 + + void + + jakarta.faces.component.UISelectOne.setGroup +
+ ( + String + ) +
+
+ Sets the name of the radio button group. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2933 + + void + + jakarta.faces.component.UIViewAction.addActionListener +
+ ( + ActionListener + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2934 + + void + + jakarta.faces.component.UIViewAction.broadcast +
+ ( + FacesEvent + ) +
+
+ Enable the method invocation specified by this component instance to return a value + that performs navigation, similar in spirit to UICommand#broadcast. Take no action and return + immediately if any of the following conditions are true. The response has already been marked as + complete. The current UIViewRoot is different from the event's source's UIViewRoot. Save a local + reference to the viewId of the current UIViewRoot. For discussion, let this reference be + viewIdBeforeAction. Obtain the ActionListener from the jakarta.faces.application.Application. Wrap + the current FacesContext in an implementation of jakarta.faces.context.FacesContextWrapper that + overrides the FacesContext#renderResponse method such that it takes no action. Set the current + FacesContext to be the FacesContextWrapper instance. Make it so a call to #isProcessingBroadcast on + the current FacesContext will return true. This is necessary because the + jakarta.faces.application.NavigationHandler will call this method to determine if the navigation is + happening as the result of a UIViewAction. Invoke ActionListener#processAction. In a finally block, + restore the original FacesContext, make it so a call to #isProcessingBroadcast on the current + context will return false and discard the wrapper. If the response has been marked as complete + during the invocation of processAction(), take no further action and return. Otherwise, compare + viewIdBeforeAction with the viewId of the UIViewRoot on the FacesContext after the invocation of + processAction(). If the two viewIds are the same and no more UIViewAction events have been queued by + a call to #decode, call FacesContext#renderResponse and return. It is possible to detect the case + where no more UIViewAction events have been queued because the number of such events queued has been + noted in the specification for #decode. Otherwise, execute the lifecycle on the new UIViewRoot. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2935 + + void + + jakarta.faces.component.UIViewAction.broadcast +
+ ( + FacesEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ Signal the Jakarta Faces implementation that no further processing on the current event + should be performed + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2936 + + void + + jakarta.faces.component.UIViewAction.decode +
+ ( + FacesContext + ) +
+
+ Override behavior from the superclass to queue an ActionEvent that may result in the + invocation of the action or any actionListeners that may be associated with this instance. Take no + action if any of the following conditions are true: The current request is a postback and the + instance has been configured to not operate on postback. See #isOnPostback. The condition stated in + the if property evaluates to false. See #isRendered . Instantiate an ActionEvent, passing this + component instance as the source. Set the phaseId property of the ActionEvent as follows. If this + component instance has been configured with a specific lifecycle phase with a call to #setPhase use + that as the phaseId If the value of the immediate property is true, use + PhaseId#APPLY_REQUEST_VALUES. Otherwise, use PhaseId#INVOKE_APPLICATION. Queue the event with a call + to #queueEvent. Keep track of the number of events that are queued in this way on this run through + the lifecycle. This information is necessary during processing in #broadcast. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2937 + + MethodExpression + + jakarta.faces.component.UIViewAction.getActionExpression +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2938 + + ActionListener[] + + jakarta.faces.component.UIViewAction.getActionListeners +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2939 + + String + + jakarta.faces.component.UIViewAction.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2940 + + String + + jakarta.faces.component.UIViewAction.getPhase +
+
+
+ Returns the name of the lifecycle phase in which the action is to be queued. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2941 + + boolean + + jakarta.faces.component.UIViewAction.isImmediate +
+
+
+ If the value of the component's immediate attribute is true, the action will be invoked + during the Apply Request Values Jakarta Faces lifecycle phase. Otherwise, the action will be invoked + during the Invoke Application phase, the default behavior. The phase can be set explicitly in the + phase attribute, which takes precedence over the immediate attribute. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2942 + + boolean + + jakarta.faces.component.UIViewAction.isOnPostback +
+
+
+ If true this component will operate on postback. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2943 + + boolean + + jakarta.faces.component.UIViewAction.isProcessingBroadcast +
+ ( + FacesContext + ) +
+
+ Returns true if the current request processing lifecycle is in the midst of processing + the broadcast of an event queued during a call to #decode. The implementation of #broadcast is + responsible for ensuring that calls to this method accurately reflect this fact. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2944 + + boolean + + jakarta.faces.component.UIViewAction.isRendered +
+
+
+ Return true if this component should take the actions specified in the #decode method. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2945 + + void + + jakarta.faces.component.UIViewAction.removeActionListener +
+ ( + ActionListener + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2946 + + void + + jakarta.faces.component.UIViewAction.setActionExpression +
+ ( + MethodExpression + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2947 + + void + + jakarta.faces.component.UIViewAction.setImmediate +
+ ( + boolean + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2948 + + void + + jakarta.faces.component.UIViewAction.setOnPostback +
+ ( + boolean + ) +
+
+ Controls whether or not this component operates on postback. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2949 + + void + + jakarta.faces.component.UIViewAction.setPhase +
+ ( + String + ) +
+
+ Attempt to set the lifecycle phase in which this instance will queue its ActionEvent. + Pass the argument phase to PhaseId#phaseIdValueOf. If the result is not one of the following values, + FacesException must be thrown. + PhaseId#APPLY_REQUEST_VALUESPhaseId#PROCESS_VALIDATIONSPhaseId#UPDATE_MODEL_VALUESPhaseId#INVOKE_APPLICATION + If set, this value takes precedence over the immediate flag. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2950 + + void + + jakarta.faces.component.UIViewAction.setRendered +
+ ( + boolean + ) +
+
+ Sets the if property of this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2951 + + UIViewAction + + jakarta.faces.component.UIViewAction.UIViewAction +
+
+
+ Create a new UIViewAction instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2952 + + void + + jakarta.faces.component.UIViewParameter.decode +
+ ( + FacesContext + ) +
+
+ Override behavior from superclass to pull a value from the incoming request parameter + map under the name given by #getName and store it with a call to UIInput#setSubmittedValue. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2953 + + void + + jakarta.faces.component.UIViewParameter.encodeAll +
+ ( + FacesContext + ) +
+
+ Called specially by UIViewRoot#encodeEnd, this method simply sets the submitted value + to be the return from #getStringValue. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2954 + + void + + jakarta.faces.component.UIViewParameter.encodeAll +
+ ( + FacesContext + ) + +
+ throws + IOException +
+
+
+ when an I/O error occurs. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2955 + + String + + jakarta.faces.component.UIViewParameter.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2956 + + String + + jakarta.faces.component.UIViewParameter.getName +
+
+
+ Return the request parameter name from which the value is retrieved. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2957 + + String + + jakarta.faces.component.UIViewParameter.getStringValue +
+ ( + FacesContext + ) +
+
+ If the value of this parameter comes from a ValueExpression return the value of the + expression, otherwise, return the local value. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2958 + + String + + jakarta.faces.component.UIViewParameter.getStringValueFromModel +
+ ( + FacesContext + ) +
+
+ Manually perform standard conversion steps to get a string value from the value + expression. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2959 + + String + + jakarta.faces.component.UIViewParameter.getStringValueFromModel +
+ ( + FacesContext + ) + +
+ throws + ConverterException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2960 + + Object + + jakarta.faces.component.UIViewParameter.getSubmittedValue +
+
+
+ Assume that the submitted value is always a string, but the return type from this + method is Object.. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2961 + + boolean + + jakarta.faces.component.UIViewParameter.isImmediate +
+
+
+ Return false. The immediate setting is not relevant for view parameters and must be + assumed to be false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2962 + + void + + jakarta.faces.component.UIViewParameter.processValidators +
+ ( + FacesContext + ) +
+
+ Specialize superclass behavior to treat null differently. In this class, a null value + along with the "required" flag being set to true will cause a validation failure. Otherwise, If the + UIInput#EMPTY_STRING_AS_NULL_PARAM_NAME context parameter is true and the value is null, call + UIInput#setSubmittedValue passing the empty string as the argument. This will cause the normal + validation processing to happen, including bean validation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2963 + + void + + jakarta.faces.component.UIViewParameter.setName +
+ ( + String + ) +
+
+ Set the request parameter name from which the value is retrieved. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2964 + + void + + jakarta.faces.component.UIViewParameter.setSubmittedValue +
+ ( + Object + ) +
+
+ PENDING (docs) Interesting that submitted value isn't saved by the parent + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2965 + + UIViewParameter + + jakarta.faces.component.UIViewParameter.UIViewParameter +
+
+
+ Create a new UIViewParameter instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2966 + + void + + jakarta.faces.component.UIViewParameter.updateModel +
+ ( + FacesContext + ) +
+
+ Call through to superclass UIInput#updateModel then take the additional action of + pushing the value into request scope if and only if the value is not a value expression, is valid, + and the local value was set on this lifecycle execution. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2967 + + UIViewParameter + + jakarta.faces.component.UIViewParameter.Reference.getUIViewParameter +
+ ( + FacesContext + ) +
+
+ Return the UIViewParameter to which this instance refers. If the current viewId is the + same as the viewId passed to our constructor, use the index passed to the constructor to find the + actual UIViewParameter instance and return it. Otherwise, call StateHolder#restoreState on the saved + state and return the result. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2968 + + Reference + + jakarta.faces.component.UIViewParameter.Reference.UIViewParameter.Reference +
+ ( + FacesContext + , +
+ UIViewParameter + , +
+ int + , +
+ String + ) +
+
+ Construct a reference to a UIViewParameter. This constructor cause the + StateHolder#saveState method to be called on argument UIViewParameter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2969 + + void + + jakarta.faces.component.UIViewRoot.addComponentResource +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Add argument component, which is assumed to represent a resource instance, as a + resource to this view. A resource instance is rendered by a resource Renderer, as described in the + Standard HTML RenderKit. The default implementation must call through to + #addComponentResource(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, + java.lang.String). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2970 + + void + + jakarta.faces.component.UIViewRoot.addComponentResource +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Add argument component, which is assumed to represent a resource instance, as a + resource to this view. A resource instance is rendered by a resource Renderer, as described in the + Standard HTML RenderKit. The component must be added using the following algorithm: If the target + argument is null, look for a target attribute on the component. If there is no target attribute, set + target to be the default value head Call #getComponentResources to obtain the child list for the + given target. If the component ID of componentResource matches the the ID of a resource that has + allready been added, remove the old resource. Add the component resource to the list. The resource + Renderer must ensure of the following: Do not render when + ResourceHandler#isResourceRendered(FacesContext, String, String) returns true. After rendering, call + ResourceHandler#markResourceRendered(FacesContext, String, String). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2971 + + void + + jakarta.faces.component.UIViewRoot.addPhaseListener +
+ ( + PhaseListener + ) +
+
+ Add the argument newPhaseListener to the list of PhaseListeners on this UIViewRoot. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2972 + + void + + jakarta.faces.component.UIViewRoot.broadcastEvents +
+ ( + FacesContext + , +
+ PhaseId + ) +
+
+ Broadcast any events that have been queued. First broadcast events that have been + queued for PhaseId#ANY_PHASE. Then broadcast ane events that have been queued for the current phase. + In both cases, UIComponent#pushComponentToEL must be called before the event is broadcast, and + UIComponent#popComponentFromEL must be called after the return from the broadcast, even in the case + of an exception. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2973 + + String + + jakarta.faces.component.UIViewRoot.createUniqueId +
+
+
+ Generate an identifier for a component. The identifier will be prefixed with + UNIQUE_ID_PREFIX, and will be unique within the non-NamingContainer child sub-trees of this + UIViewRoot. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2974 + + String + + jakarta.faces.component.UIViewRoot.createUniqueId +
+ ( + FacesContext + , +
+ String + ) +
+
+ Generate an identifier for a component. The identifier will be prefixed with + UNIQUE_ID_PREFIX, and will be unique within this UIViewRoot. Optionally, a unique seed value can be + supplied by component creators which should be included in the generated unique id. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2975 + + void + + jakarta.faces.component.UIViewRoot.encodeBegin +
+ ( + FacesContext + ) +
+
+ Override the default UIComponentBase#encodeBegin behavior. If #getBeforePhaseListener + returns non-null, invoke it, passing a PhaseEvent for the PhaseId#RENDER_RESPONSE phase. If the + internal list populated by calls to #addPhaseListener is non-empty, any listeners in that list must + have their PhaseListener#beforePhase method called, passing the PhaseEvent. Any Exceptions that + occur during invocation of any of the beforePhase listeners must be logged and swallowed, unless the + #VIEWROOT_PHASE_LISTENER_QUEUES_EXCEPTIONS_PARAM_NAME parameter is set. In that case, the Exception + must be passed to the jakarta.faces.context.ExceptionHandler as well. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2976 + + void + + jakarta.faces.component.UIViewRoot.encodeBegin +
+ ( + FacesContext + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2977 + + void + + jakarta.faces.component.UIViewRoot.encodeChildren +
+ ( + FacesContext + ) +
+
+ If jakarta.faces.context.PartialViewContext#isAjaxRequest returns true, perform partial + rendering by calling jakarta.faces.context.PartialViewContext#processPartial with + PhaseId#RENDER_RESPONSE. If jakarta.faces.context.PartialViewContext#isAjaxRequest returns false, + delegate to the parent jakarta.faces.component.UIComponentBase#encodeChildren method. If this + UIViewRoot is an instance of NamingContainer, then the Jakarta Faces implementation must ensure that + all encoded POST request parameter names are prefixed with + UIViewRoot#getContainerClientId(FacesContext) as per rules of UIComponent#getClientId(FacesContext). + This also covers all predefined POST request parameters which are listed below: + ResponseStateManager#VIEW_STATE_PARAMResponseStateManager#CLIENT_WINDOW_PARAMResponseStateManager#RENDER_KIT_ID_PARAMClientBehaviorContext#BEHAVIOR_SOURCE_PARAM_NAMEClientBehaviorContext#BEHAVIOR_EVENT_PARAM_NAMEPartialViewContext#PARTIAL_EVENT_PARAM_NAMEPartialViewContext#PARTIAL_EXECUTE_PARAM_NAMEPartialViewContext#PARTIAL_RENDER_PARAM_NAMEPartialViewContext#RESET_VALUES_PARAM_NAME + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2978 + + void + + jakarta.faces.component.UIViewRoot.encodeChildren +
+ ( + FacesContext + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2979 + + void + + jakarta.faces.component.UIViewRoot.encodeEnd +
+ ( + FacesContext + ) +
+
+ If #getAfterPhaseListener returns non-null, invoke it, passing a PhaseEvent for the + PhaseId#RENDER_RESPONSE phase. Any Exceptions that occur during invocation of the afterPhase + listener must be logged and swallowed, unless the + #VIEWROOT_PHASE_LISTENER_QUEUES_EXCEPTIONS_PARAM_NAME parameter is set. In that case, the Exception + must be passed to the jakarta.faces.context.ExceptionHandler as well.. If the current view has view + parameters, as indicated by a non-empty and non-UnsupportedOperationException throwing return from + jakarta.faces.view.ViewDeclarationLanguage#getViewMetadata(jakarta.faces.context.FacesContext, + String), call UIViewParameter#encodeAll on each parameter. If calling getViewParameters() causes + UnsupportedOperationException to be thrown, the exception must be silently swallowed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2980 + + void + + jakarta.faces.component.UIViewRoot.encodeEnd +
+ ( + FacesContext + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:2981 + + MethodExpression + + jakarta.faces.component.UIViewRoot.getAfterPhaseListener +
+
+
+ Return the MethodExpression that will be invoked after this view is rendered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2982 + + MethodExpression + + jakarta.faces.component.UIViewRoot.getBeforePhaseListener +
+
+
+ Return the MethodExpression that will be invoked before this view is rendered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2983 + + List + + jakarta.faces.component.UIViewRoot.getComponentResources +
+ ( + FacesContext + , +
+ String + ) +
+
+ Return an unmodifiable List of UIComponents for the provided target agrument. Each + component in the List is assumed to represent a resource instance. The default implementation must + use an algorithm equivalent to the the following. Locate the facet for the component by calling + getFacet() using target as the argument. If the facet is not found, create the facet by calling + context.getApplication().createComponent(). The argument to this method must refer to a component + that extends UIPanel and overrides the encodeAll() method to take no action. This is necessary to + prevent component resources from being inadvertently rendered. Set the id of the facet to be a + string created by prepending the literal string #8220;jakarta_faces_location_ #8221; (without the + quotes) to the value of the target argument Add the facet to the facets Map using target as the key + return the children of the facet + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2984 + + List + + jakarta.faces.component.UIViewRoot.getComponentResources +
+ ( + FacesContext + ) +
+
+ Return an unmodifiable ordered List of all UIComponent resources of all supported + targets. Each component in the List is assumed to represent a resource instance. The ordering is the + same as the resources would appear in the component tree. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2985 + + Doctype + + jakarta.faces.component.UIViewRoot.getDoctype +
+
+
+ Return the doctype of this view. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2986 + + String + + jakarta.faces.component.UIViewRoot.getFamily +
+
+
+ Return the identifier of the component family to which this component belongs. This + identifier, in conjunction with the value of the rendererType property, may be used to select the + appropriate Renderer for this component instance. Note this method should NOT return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2987 + + Locale + + jakarta.faces.component.UIViewRoot.getLocale +
+
+
+ Return the Locale to be used in localizing the response being created for this view. + Algorithm: If we have a locale ivar, return it. If we have a value expression for "locale", get its + value. If the value is null, return the result of calling + jakarta.faces.application.ViewHandler#calculateLocale. If the value is an instance of + java.util.Locale return it. If the value is a String, convert it to a java.util.Locale and return + it. If there is no value expression for "locale", return the result of calling + jakarta.faces.application.ViewHandler#calculateLocale. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2988 + + List + + jakarta.faces.component.UIViewRoot.getPhaseListeners +
+
+
+ Return an unmodifiable list of the PhaseListener instances attached to this UIViewRoot + instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2989 + + String + + jakarta.faces.component.UIViewRoot.getRenderKitId +
+
+
+ Return the render kit identifier of the jakarta.faces.render.RenderKit associated with + this view. Unless explicitly set, as in jakarta.faces.application.ViewHandler#createView, the + returned value will be null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2990 + + boolean + + jakarta.faces.component.UIViewRoot.getRendersChildren +
+
+
+ Call UIComponentBase#getRendersChildren If + jakarta.faces.context.PartialViewContext#isAjaxRequest returns true this method must return true. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2991 + + String + + jakarta.faces.component.UIViewRoot.getViewId +
+
+
+ Return the view identifier for this view. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2992 + + List + + jakarta.faces.component.UIViewRoot.getViewListenersForEventClass +
+ ( + Class + ) +
+
+ Return the SystemEventListener instances registered on this UIComponent instance that + are interested in events of type eventClass. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2993 + + Map + + jakarta.faces.component.UIViewRoot.getViewMap +
+
+
+ This implementation simply calls through to #getViewMap(boolean), passing true as the + argument, and returns the result. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2994 + + Map + + jakarta.faces.component.UIViewRoot.getViewMap +
+ ( + boolean + ) +
+
+ Returns a Map that acts as the interface to the data store that is the "view scope", + or, if this instance does not have such a Map and the create argument is true, creates one and + returns it. This map must be instantiated lazily and cached for return from subsequent calls to this + method on this UIViewRoot instance. jakarta.faces.application.Application#publishEvent must be + called, passing the current FacesContext as the first argument, PostConstructViewMapEvent.class as + the second argument, UIViewRoot.class as the third argument and this UIViewRoot instance as the + fourth argument. It is necessary to pass the UIViewRoot.class argument to account for cases when the + UIViewRoot has been extended with a custom class. The returned Map must be implemented such that + calling clear() on the Map causes jakarta.faces.application.Application#publishEvent to be called, + passing PreDestroyViewMapEvent.class as the first argument and this UIViewRoot instance as the + second argument. Depending upon application configuration, objects stored in the view map may need + to be Serializable. In general, it is a good idea to ensure that any objects stored in the view map + are Serializable. For reasons made clear in jakarta.faces.view.ViewScoped, this map must ultimately + be stored in the session. For this reason, a true value for the create argument will force the + session to be created with a call to jakarta.faces.context.ExternalContext#getSession(boolean). See + FacesContext#setViewRoot for the specification of when the clear() method must be called. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2995 + + boolean + + jakarta.faces.component.UIViewRoot.isInView +
+
+
+ Override superclass method to always return true because a UIViewRoot is defined to + always be in a view. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2996 + + void + + jakarta.faces.component.UIViewRoot.processApplication +
+ ( + FacesContext + ) +
+
+ Broadcast any events that have been queued for the Invoke Application phase of the + request processing lifecycle and to clear out any events for later phases if the event processing + for this phase caused FacesContext#renderResponse or FacesContext#responseComplete to be called. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2997 + + void + + jakarta.faces.component.UIViewRoot.processDecodes +
+ ( + FacesContext + ) +
+
+ Perform partial processing by calling + jakarta.faces.context.PartialViewContext#processPartial with PhaseId#APPLY_REQUEST_VALUES if: + jakarta.faces.context.PartialViewContext#isPartialRequest returns true and we don't have a request + to process all components in the view (jakarta.faces.context.PartialViewContext#isExecuteAll returns + false) Perform full processing by calling UIComponentBase#processDecodes if one of the following + conditions are met: jakarta.faces.context.PartialViewContext#isPartialRequest returns true and we + have a request to process all components in the view + (jakarta.faces.context.PartialViewContext#isExecuteAll returns true) + jakarta.faces.context.PartialViewContext#isPartialRequest returns false Override the default + UIComponentBase#processDecodes behavior to broadcast any queued events after the default processing + or partial processing has been completed and to clear out any events for later phases if the event + processing for this phase caused FacesContext#renderResponse or FacesContext#responseComplete to be + called. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2998 + + void + + jakarta.faces.component.UIViewRoot.processEvent +
+ ( + ComponentSystemEvent + ) +
+
+ If the argument event is an instance of PostRestoreStateEvent and + PartialViewContext#isPartialRequest() returns true, then loop over all component resources and call + ResourceHandler#markResourceRendered(FacesContext, String, String) for each of them. Finally, + delegate to super. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:2999 + + void + + jakarta.faces.component.UIViewRoot.processEvent +
+ ( + ComponentSystemEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3000 + + void + + jakarta.faces.component.UIViewRoot.processRestoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ The default implementation must call UIComponentBase#processRestoreState from within a + try block. The try block must have a finally block that ensures that no FacesEvents remain in the + event queue. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3001 + + void + + jakarta.faces.component.UIViewRoot.processUpdates +
+ ( + FacesContext + ) +
+
+ Perform partial processing by calling + jakarta.faces.context.PartialViewContext#processPartial with PhaseId#UPDATE_MODEL_VALUES if: + jakarta.faces.context.PartialViewContext#isPartialRequest returns true and we don't have a request + to process all components in the view (jakarta.faces.context.PartialViewContext#isExecuteAll returns + false) Perform full processing by calling UIComponentBase#processUpdates if one of the following + conditions are met: jakarta.faces.context.PartialViewContext#isPartialRequest returns true and we + have a request to process all components in the view + (jakarta.faces.context.PartialViewContext#isExecuteAll returns true) + jakarta.faces.context.PartialViewContext#isPartialRequest returns false Override the default + UIComponentBase behavior to broadcast any queued events after the default processing or partial + processing has been completed and to clear out any events for later phases if the event processing + for this phase caused FacesContext#renderResponse or FacesContext#responseComplete to be called. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3002 + + void + + jakarta.faces.component.UIViewRoot.processValidators +
+ ( + FacesContext + ) +
+
+ Perform partial processing by calling + jakarta.faces.context.PartialViewContext#processPartial with PhaseId#PROCESS_VALIDATIONS if: + jakarta.faces.context.PartialViewContext#isPartialRequest returns true and we don't have a request + to process all components in the view (jakarta.faces.context.PartialViewContext#isExecuteAll returns + false) Perform full processing by calling UIComponentBase#processValidators if one of the following + conditions are met: jakarta.faces.context.PartialViewContext#isPartialRequest returns true and we + have a request to process all components in the view + (jakarta.faces.context.PartialViewContext#isExecuteAll returns true) + jakarta.faces.context.PartialViewContext#isPartialRequest returns false Override the default + UIComponentBase#processValidators behavior to broadcast any queued events after the default + processing or partial processing has been completed and to clear out any events for later phases if + the event processing for this phase caused FacesContext#renderResponse or + FacesContext#responseComplete to be called. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3003 + + void + + jakarta.faces.component.UIViewRoot.queueEvent +
+ ( + FacesEvent + ) +
+
+ Override the default UIComponentBase#queueEvent behavior to accumulate the queued + events for later broadcasting. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3004 + + void + + jakarta.faces.component.UIViewRoot.removeComponentResource +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Remove argument component, which is assumed to represent a resource instance, as a + resource to this view. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3005 + + void + + jakarta.faces.component.UIViewRoot.removeComponentResource +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Remove argument component, which is assumed to represent a resource instance, as a + resource to this view. A resource instance is rendered by a resource Renderer, as described in the + Standard HTML RenderKit. The component must be removed using the following algorithm: If the target + argument is null, look for a target attribute on the component. If there is no target attribute, set + target to be the default value head Call #getComponentResources to obtain the child list for the + given target. Remove the component resource from the child list. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3006 + + void + + jakarta.faces.component.UIViewRoot.removePhaseListener +
+ ( + PhaseListener + ) +
+
+ If the argument toRemove is in the list of PhaseListeners for this instance, it must be + removed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3007 + + void + + jakarta.faces.component.UIViewRoot.resetValues +
+ ( + FacesContext + , +
+ Collection + ) +
+
+ Visit the clientIds and, if the component is an instance of EditableValueHolder, call + its EditableValueHolder#resetValue method. Use #visitTree to do the visiting. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3008 + + void + + jakarta.faces.component.UIViewRoot.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3009 + + void + + jakarta.faces.component.UIViewRoot.restoreViewScopeState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ Restore ViewScope state. This is needed to allow the use of view scoped beans for + EL-expressions in the template from which the component tree is built. For example: . + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3010 + + Object + + jakarta.faces.component.UIViewRoot.saveState +
+ ( + FacesContext + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3011 + + void + + jakarta.faces.component.UIViewRoot.setAfterPhaseListener +
+ ( + MethodExpression + ) +
+
+ Allow an arbitrary method to be called for the "afterPhase" event as the UIViewRoot + runs through its lifecycle. This method will be called for all phases including + PhaseId#RESTORE_VIEW. Unlike a true PhaseListener, this approach doesn't allow for only receiving + PhaseEvents for a given phase. The method must conform to the signature of PhaseListener#afterPhase. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3012 + + void + + jakarta.faces.component.UIViewRoot.setBeforePhaseListener +
+ ( + MethodExpression + ) +
+
+ Allow an arbitrary method to be called for the "beforePhase" event as the UIViewRoot + runs through its lifecycle. This method will be called for all phases except PhaseId#RESTORE_VIEW. + Unlike a true PhaseListener, this approach doesn't allow for only receiving PhaseEvents for a given + phase. The method must conform to the signature of PhaseListener#beforePhase. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3013 + + void + + jakarta.faces.component.UIViewRoot.setDoctype +
+ ( + Doctype + ) +
+
+ Set the doctype of this view. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3014 + + void + + jakarta.faces.component.UIViewRoot.setInView +
+ ( + boolean + ) +
+
+ Overridden to take no action. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3015 + + void + + jakarta.faces.component.UIViewRoot.setLocale +
+ ( + Locale + ) +
+
+ Set the Locale to be used in localizing the response being created for this view. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3016 + + void + + jakarta.faces.component.UIViewRoot.setRenderKitId +
+ ( + String + ) +
+
+ Set the render kit identifier of the jakarta.faces.render.RenderKit associated with + this view. This method may be called at any time between the end of Apply Request Values phase of + the request processing lifecycle (i.e. when events are being broadcast) and the beginning of the + Render Response phase. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3017 + + void + + jakarta.faces.component.UIViewRoot.setViewId +
+ ( + String + ) +
+
+ Set the view identifier for this view. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3018 + + void + + jakarta.faces.component.UIViewRoot.subscribeToViewEvent +
+ ( + Class + , +
+ SystemEventListener + ) +
+
+ Install the listener instance referenced by argument listener into the UIViewRoot as a + listener for events of type systemEventClass. Note that installed listeners are not maintained as + part of the UIViewRoot's state. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3019 + + UIViewRoot + + jakarta.faces.component.UIViewRoot.UIViewRoot +
+
+
+ Create a new UIViewRoot instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3020 + + void + + jakarta.faces.component.UIViewRoot.unsubscribeFromViewEvent +
+ ( + Class + , +
+ SystemEventListener + ) +
+
+ Remove the listener instance referenced by argument listener from the UIViewRoot as a + listener for events of type systemEventClass. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3021 + + String + + jakarta.faces.component.UIWebsocket.getChannel +
+
+
+ Returns the name of the websocket channel. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3022 + + Collection + + jakarta.faces.component.UIWebsocket.getEventNames +
+
+
+ Returns a non-null, empty, unmodifiable Collection which returns true on any + Collection#contains() invocation, indicating that all client behavior event names are acceptable. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3023 + + String + + jakarta.faces.component.UIWebsocket.getFamily +
+
+
+ Returns UIWebsocket#COMPONENT_FAMILY. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3024 + + String + + jakarta.faces.component.UIWebsocket.getOnclose +
+
+
+ Returns the JavaScript event handler function that is invoked when the websocket is + closed and will not anymore attempt to reconnect. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3025 + + String + + jakarta.faces.component.UIWebsocket.getOnerror +
+
+
+ Returns the JavaScript event handler function that is invoked when a connection error + has occurred and the websocket will attempt to reconnect. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3026 + + String + + jakarta.faces.component.UIWebsocket.getOnmessage +
+
+
+ Returns the JavaScript event handler function that is invoked when a push message is + received from the server. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3027 + + String + + jakarta.faces.component.UIWebsocket.getOnopen +
+
+
+ Returns the JavaScript event handler function that is invoked when the websocket is + opened. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3028 + + String + + jakarta.faces.component.UIWebsocket.getScope +
+
+
+ Returns the scope of the websocket channel. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3029 + + Serializable + + jakarta.faces.component.UIWebsocket.getUser +
+
+
+ Returns the user identifier of the websocket channel. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3030 + + boolean + + jakarta.faces.component.UIWebsocket.isConnected +
+
+
+ Returns whether to (auto)connect the websocket or not. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3031 + + void + + jakarta.faces.component.UIWebsocket.setChannel +
+ ( + String + ) +
+
+ Sets the name of the websocket channel. It may not be an Jakarta Expression Language + expression and it may only contain alphanumeric characters, hyphens, underscores and periods. All + open websockets on the same channel will receive the same push message from the server. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3032 + + void + + jakarta.faces.component.UIWebsocket.setConnected +
+ ( + boolean + ) +
+
+ Sets whether to (auto)connect the websocket or not. Defaults to true. It's interpreted + as a JavaScript instruction whether to open or close the websocket push connection. Note that this + attribute is re-evaluated on every ajax request. You can also explicitly set it to false and then + manually control in JavaScript by faces.push.open("channelName") and + faces.push.close("channelName"). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3033 + + void + + jakarta.faces.component.UIWebsocket.setOnclose +
+ ( + String + ) +
+
+ Sets the JavaScript event handler function that is invoked when the websocket is closed + and will not anymore attempt to reconnect. The function will be invoked with three arguments: the + close reason code, the channel name and the raw CloseEvent itself. Note that this will also be + invoked when the close is caused by an error and that you can inspect the close reason code if an + actual connection error occurred and which one (i.e. when the code is not 1000 or 1008). See also + RFC 6455 section 7.4.1 and CloseCodes API for an elaborate list of all close codes. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3034 + + void + + jakarta.faces.component.UIWebsocket.setOnerror +
+ ( + String + ) +
+
+ Sets the JavaScript event handler function that is invoked when a connection error has + occurred and the websocket will attempt to reconnect. The function will be invoked with three + arguments: the error reason code, the channel name and the raw CloseEvent itself. Note that this + will not be invoked on final close of the websocket, even when the final close is caused by an + error. See also RFC 6455 section 7.4.1 and CloseCodes API for an elaborate list of all close codes. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3035 + + void + + jakarta.faces.component.UIWebsocket.setOnmessage +
+ ( + String + ) +
+
+ Sets the JavaScript event handler function that is invoked when a push message is + received from the server. The function will be invoked with three arguments: the push message, the + channel name and the raw MessageEvent itself. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3036 + + void + + jakarta.faces.component.UIWebsocket.setOnopen +
+ ( + String + ) +
+
+ Sets the JavaScript event handler function that is invoked when the websocket is + opened. The function will be invoked with one argument: the channel name. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3037 + + void + + jakarta.faces.component.UIWebsocket.setScope +
+ ( + String + ) +
+
+ Sets the scope of the websocket channel. It may not be an Jakarta Expression Language + expression and allowed values are application, session and view, case insensitive. When the value is + application, then all channels with the same name throughout the application will receive the same + push message. When the value is session, then only the channels with the same name in the current + user session will receive the same push message. When the value is view, then only the channel in + the current view will receive the push message. The default scope is application. When the user + attribute is specified, then the default scope is session. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3038 + + void + + jakarta.faces.component.UIWebsocket.setUser +
+ ( + Serializable + ) +
+
+ Sets the user identifier of the websocket channel, so that user-targeted push messages + can be sent. All open websockets on the same channel and user will receive the same push message + from the server. It must implement Serializable and preferably have low memory footprint. + Suggestion: use #{request.remoteUser} or #{someLoggedInUser.id}. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3039 + + void + + jakarta.faces.component.UIWebsocket.setValueExpression +
+ ( + String + , +
+ ValueExpression + ) +
+
+ Set the ValueExpression used to calculate the value for the specified attribute or + property name, if any. If a ValueExpression is set for the channel or scope property, regardless of + the value, throw an illegal argument exception. If a ValueExpression is set for the user property, + and the non-null value is not an instance of Serializable, throw an illegal argument exception. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3040 + + UIWebsocket + + jakarta.faces.component.UIWebsocket.UIWebsocket +
+
+
+ Create a new UIWebsocket instance with default property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3041 + + String + + jakarta.faces.component.UniqueIdVendor.createUniqueId +
+ ( + FacesContext + , +
+ String + ) +
+
+ Generate an identifier for a component. The identifier will be prefixed with + UNIQUE_ID_PREFIX, and will be unique within this component-container. Optionally, a unique seed + value can be supplied by component creators which should be included in the generated unique id. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3042 + + FacesMessage + + jakarta.faces.component.UpdateModelException.getFacesMessage +
+
+
+ Return the FacesMessage passed to the constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3043 + + UpdateModelException + + jakarta.faces.component.UpdateModelException.UpdateModelException +
+ ( + FacesMessage + , +
+ Throwable + ) +
+
+ Store the argument facesMessage so it may be returned from #getFacesMessage and pass + the argument cause to the super constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3044 + + Converter + + jakarta.faces.component.ValueHolder.getConverter +
+
+
+ Return the Converter (if any) that is registered for this UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3045 + + Object + + jakarta.faces.component.ValueHolder.getLocalValue +
+
+
+ Return the local value of this UIComponent (if any), without evaluating any associated + ValueExpression. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3046 + + Object + + jakarta.faces.component.ValueHolder.getValue +
+
+
+ Gets the value of this UIComponent. If validation failed, as indicated by + jakarta.faces.context.FacesContext#isValidationFailed returning true, always return the local value. + Otherwise, first, consult the local value property of this component. If non-null return it. If + null, see if we have a ValueExpression for the value property. If so, return the result of + evaluating the property, otherwise return null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3047 + + void + + jakarta.faces.component.ValueHolder.setConverter +
+ ( + Converter + ) +
+
+ Set the Converter (if any) that is registered for this UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3048 + + void + + jakarta.faces.component.ValueHolder.setValue +
+ ( + Object + ) +
+
+ Set the value of this UIComponent (if any). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3049 + + void + + jakarta.faces.component.behavior.AjaxBehavior.addAjaxBehaviorListener +
+ ( + AjaxBehaviorListener + ) +
+
+ Add the specified AjaxBehaviorListener to the set of listeners registered to receive + event notifications from this AjaxBehavior. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3050 + + AjaxBehavior + + jakarta.faces.component.behavior.AjaxBehavior.AjaxBehavior +
+
+
+ Default constructor that just creates this instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3051 + + String + + jakarta.faces.component.behavior.AjaxBehavior.getDelay +
+
+
+ Returns the delay value, or null if no value was set. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3052 + + Collection + + jakarta.faces.component.behavior.AjaxBehavior.getExecute +
+
+
+ Return a non-empty Collection of component identifiers that will be used to identify + components that should be processed during the execute phase of the request processing lifecycle. + Note that the returned collection may be unmodifiable. Modifications should be performed by calling + #setExecute. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3053 + + Set + + jakarta.faces.component.behavior.AjaxBehavior.getHints +
+
+
+ This method returns an unmodifiable Set containing the ClientBehaviorHint SUBMITTING. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3054 + + String + + jakarta.faces.component.behavior.AjaxBehavior.getOnerror +
+
+
+ Return the String of JavaScript function name that will be used to identify the client + callback function that should be run in the event of an error. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3055 + + String + + jakarta.faces.component.behavior.AjaxBehavior.getOnevent +
+
+
+ Return the String of JavaScript function name that will be used to identify the client + callback function that should be run on the occurance of a client-side event. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3056 + + Collection + + jakarta.faces.component.behavior.AjaxBehavior.getRender +
+
+
+ Return a non-empty Collection of component identifiers that will be used to identify + components that should be processed during the render phase of the request processing lifecycle. + Note that the returned collection may be unmodifiable. Modifications should be performed by calling + #setRender. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3057 + + String + + jakarta.faces.component.behavior.AjaxBehavior.getRendererType +
+
+
+ Returns the renderer type of the ClientBehaviorRenderer to use for the behavior. The + default implementation returns null. Subclasses should either override this method to return a + string that identifies the type of ClientBehaviorRenderer to use, or should override #getScript and + perform script rendering locally in the ClientBehavior implementation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3058 + + ValueExpression + + jakarta.faces.component.behavior.AjaxBehavior.getValueExpression +
+ ( + String + ) +
+
+ Returns the ValueExpression used to calculate the value for the specified property + name, if any. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3059 + + boolean + + jakarta.faces.component.behavior.AjaxBehavior.isDisabled +
+
+
+ Return the disabled status of this behavior. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3060 + + boolean + + jakarta.faces.component.behavior.AjaxBehavior.isImmediate +
+
+
+ Return the immediate status of this behavior. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3061 + + boolean + + jakarta.faces.component.behavior.AjaxBehavior.isImmediateSet +
+
+
+ Tests whether the immediate attribute is specified. Returns true if the immediate + attribute is specified, either as a locally set property or as a value expression. This information + allows an associated client behavior renderer to fall back on the parent component's immediate + status when immediate is not explicitly specified on the AjaxBehavior. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3062 + + boolean + + jakarta.faces.component.behavior.AjaxBehavior.isResetValues +
+
+
+ Return the resetValues status of this behavior. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3063 + + boolean + + jakarta.faces.component.behavior.AjaxBehavior.isResetValuesSet +
+
+
+ Tests whether the resetValues attribute is specified. Returns true if the resetValues + attribute is specified, either as a locally set property or as a value expression. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3064 + + void + + jakarta.faces.component.behavior.AjaxBehavior.removeAjaxBehaviorListener +
+ ( + AjaxBehaviorListener + ) +
+
+ Remove the specified AjaxBehaviorListener from the set of listeners registered to + receive event notifications from this AjaxBehavior. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3065 + + void + + jakarta.faces.component.behavior.AjaxBehavior.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ Implementation of jakarta.faces.component.StateHolder#restoreState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3066 + + Object + + jakarta.faces.component.behavior.AjaxBehavior.saveState +
+ ( + FacesContext + ) +
+
+ Implementation of jakarta.faces.component.StateHolder#saveState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3067 + + void + + jakarta.faces.component.behavior.AjaxBehavior.setDelay +
+ ( + String + ) +
+
+ If less than delay milliseconds elapses between calls to request() only the most recent + one is sent and all other requests are discarded. The default value of this option is 300. If the + value of delay is the literal string 'none' without the quotes, no delay is used. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3068 + + void + + jakarta.faces.component.behavior.AjaxBehavior.setDisabled +
+ ( + boolean + ) +
+
+ Sets the disabled status of this behavior. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3069 + + void + + jakarta.faces.component.behavior.AjaxBehavior.setExecute +
+ ( + Collection + ) +
+
+ Sets the component identifiers that will be used to identify components that should be + processed during the execute phase of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3070 + + void + + jakarta.faces.component.behavior.AjaxBehavior.setImmediate +
+ ( + boolean + ) +
+
+ Sets the immediate status of this behavior. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3071 + + void + + jakarta.faces.component.behavior.AjaxBehavior.setOnerror +
+ ( + String + ) +
+
+ Sets the JavaScript function name that will be used to identify the client callback + function that should be run in the event of an error. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3072 + + void + + jakarta.faces.component.behavior.AjaxBehavior.setOnevent +
+ ( + String + ) +
+
+ Sets the JavaScript function name that will be used to identify the client callback + function that should be run in response to event activity. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3073 + + void + + jakarta.faces.component.behavior.AjaxBehavior.setRender +
+ ( + Collection + ) +
+
+ Sets the component identifiers that will be used to identify components that should be + processed during the render phase of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3074 + + void + + jakarta.faces.component.behavior.AjaxBehavior.setResetValues +
+ ( + boolean + ) +
+
+ Set the resetValues status of this behavior. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3075 + + void + + jakarta.faces.component.behavior.AjaxBehavior.setValueExpression +
+ ( + String + , +
+ ValueExpression + ) +
+
+ Sets the ValueExpression used to calculate the value for the specified property name. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3076 + + void + + jakarta.faces.component.behavior.Behavior.broadcast +
+ ( + BehaviorEvent + ) +
+
+ Broadcast the specified BehaviorEvent to all registered event listeners who have + expressed an interest in events of this type. Listeners are called in the order in which they were + added. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3077 + + BehaviorBase + + jakarta.faces.component.behavior.BehaviorBase.BehaviorBase +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3078 + + void + + jakarta.faces.component.behavior.BehaviorBase.broadcast +
+ ( + BehaviorEvent + ) +
+
+ Default implementation of Behavior#broadcast. Delivers the specified BehaviorEvent to + all registered BehaviorListener event listeners who have expressed an interest in events of this + type. Listeners are called in the order in which they were registered (added). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3079 + + void + + jakarta.faces.component.behavior.BehaviorBase.broadcast +
+ ( + BehaviorEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ Signal the Jakarta Faces implementation that no further processing on the current event + should be performed + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3080 + + void + + jakarta.faces.component.behavior.BehaviorBase.clearInitialState +
+
+
+ Clears the initial state flag, causing the behavior to revert from partial to full + state saving. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3081 + + boolean + + jakarta.faces.component.behavior.BehaviorBase.initialStateMarked +
+
+
+ Implementation of jakarta.faces.component.PartialStateHolder#initialStateMarked. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3082 + + boolean + + jakarta.faces.component.behavior.BehaviorBase.isTransient +
+
+
+ Implementation of jakarta.faces.component.StateHolder#isTransient. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3083 + + void + + jakarta.faces.component.behavior.BehaviorBase.markInitialState +
+
+
+ Implementation of jakarta.faces.component.PartialStateHolder#markInitialState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3084 + + void + + jakarta.faces.component.behavior.BehaviorBase.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ Implementation of jakarta.faces.component.StateHolder#restoreState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3085 + + Object + + jakarta.faces.component.behavior.BehaviorBase.saveState +
+ ( + FacesContext + ) +
+
+ Implementation of jakarta.faces.component.StateHolder#saveState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3086 + + void + + jakarta.faces.component.behavior.BehaviorBase.setTransient +
+ ( + boolean + ) +
+
+ Implementation of jakarta.faces.component.StateHolder#setTransient. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3087 + + void + + jakarta.faces.component.behavior.ClientBehavior.decode +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Decode any new state of this ClientBehavior from the request contained in the specified + FacesContext. During decoding, events may be enqueued for later processing (by event listeners who + have registered an interest), by calling queueEvent(). Default implementation delegates decoding to + jakarta.faces.render.ClientBehaviorRenderer#decode(FacesContext, UIComponent, ClientBehavior) + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3088 + + Set + + jakarta.faces.component.behavior.ClientBehavior.getHints +
+
+
+ Returns hints that describe the behavior of the ClientBehavior implementation. The + hints may impact how Renderers behave in the presence of Behaviors. For example, when a Behavior + that specifies ClientBehaviorHint.SUBMITTING is present, the Renderer may choose to alternate the + scripts that it generates itself. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3089 + + String + + jakarta.faces.component.behavior.ClientBehavior.getScript +
+ ( + ClientBehaviorContext + ) +
+
+ Return the script that implements this ClientBehavior's client-side logic. + ClientBehavior.getScript() implementations are allowed to return null to indicate that no script is + required for this particular getScript() call. For example, a ClientBehavior implementation may + return null if the Behavior is disabled. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3090 + + ClientBehaviorBase + + jakarta.faces.component.behavior.ClientBehaviorBase.ClientBehaviorBase +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3091 + + void + + jakarta.faces.component.behavior.ClientBehaviorBase.decode +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Default implementation of of ClientBehavior#decode. If a ClientBehaviorRenderer is + available for the specified behavior renderer type, this method delegates to the + ClientBehaviorRenderer's decode() method. Otherwise, no decoding is performed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3092 + + Set + + jakarta.faces.component.behavior.ClientBehaviorBase.getHints +
+
+
+ Default implementation of ClientBehavior#getHints(). By default, no hints are + specified, and this method returns an empty, umodifiable set. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3093 + + String + + jakarta.faces.component.behavior.ClientBehaviorBase.getRendererType +
+
+
+ Returns the renderer type of the ClientBehaviorRenderer to use for the behavior. The + default implementation returns null. Subclasses should either override this method to return a + string that identifies the type of ClientBehaviorRenderer to use, or should override #getScript and + perform script rendering locally in the ClientBehavior implementation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3094 + + String + + jakarta.faces.component.behavior.ClientBehaviorBase.getScript +
+ ( + ClientBehaviorContext + ) +
+
+ Default implementation of of ClientBehavior#getScript. If a ClientBehaviorRenderer is + available for the specified behavior renderer type, this method delegates to the + ClientBehaviorRenderer#getScript method. Otherwise, this method returns null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3095 + + ClientBehaviorContext + + jakarta.faces.component.behavior.ClientBehaviorContext.ClientBehaviorContext +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3096 + + ClientBehaviorContext + + jakarta.faces.component.behavior.ClientBehaviorContext.createClientBehaviorContext +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + , +
+ String + , +
+ Collection + ) +
+
+ Creates a ClientBehaviorContext instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3097 + + UIComponent + + jakarta.faces.component.behavior.ClientBehaviorContext.getComponent +
+
+
+ Returns the UIComponent that is requesting the ClientBehavior script. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3098 + + String + + jakarta.faces.component.behavior.ClientBehaviorContext.getEventName +
+
+
+ Returns the name of the behavior event for which the ClientBehavior script is being + requested. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3099 + + FacesContext + + jakarta.faces.component.behavior.ClientBehaviorContext.getFacesContext +
+
+
+ Returns the FacesContext for the current request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3100 + + Collection + + jakarta.faces.component.behavior.ClientBehaviorContext.getParameters +
+
+
+ Returns parameters that "submitting" ClientBehavior implementations should include when + posting back data into the Faces lifecycle. If no parameters are specified, this method returns an + empty (non-null) collection. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3101 + + String + + jakarta.faces.component.behavior.ClientBehaviorContext.getSourceId +
+
+
+ Returns an id for use as the ClientBehavior source. ClientBehavior implementations that + submit back to the Faces lifecycle are required to identify which component triggered the + ClientBehavior-initiated request via the jakarta.faces.source request parameter. In most cases, th + source id can be trivially derived from the element to which the behavior's client-side script is + attached - ie. the source id is typically the id of this element. However, in components which + produce more complex content, the behavior script may not be able to determine the correct id to use + for the jakarta.faces.source value. The ClientBehaviorContext#getSourceId method allows the + component to pass this information into the ClientBehavior#getScript implementation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3102 + + Parameter + + + jakarta.faces.component.behavior.ClientBehaviorContext.Parameter.ClientBehaviorContext.Parameter +
+ ( + String + , +
+ Object + ) +
+
+ Creates a Parameter instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3103 + + String + + jakarta.faces.component.behavior.ClientBehaviorContext.Parameter.getName +
+
+
+ Returns the Parameter's name. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3104 + + Object + + jakarta.faces.component.behavior.ClientBehaviorContext.Parameter.getValue +
+
+
+ Returns the Parameter's value. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3105 + + ClientBehaviorHint + + jakarta.faces.component.behavior.ClientBehaviorHint.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3106 + + ClientBehaviorHint[] + + jakarta.faces.component.behavior.ClientBehaviorHint.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3107 + + void + + jakarta.faces.component.behavior.ClientBehaviorHolder.addClientBehavior +
+ ( + String + , +
+ ClientBehavior + ) +
+
+ Attaches a ClientBehavior to the component implementing this interface for the + specified event. Valid event names for a UIComponent implementation are defined by + ClientBehaviorHolder.getEventNames(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3108 + + Map + + jakarta.faces.component.behavior.ClientBehaviorHolder.getClientBehaviors +
+
+
+ Returns a non-null, unmodifiable Map that contains the the ClientBehaviors that have + been attached to the component implementing this interface. The keys in this Map are event names + defined by #getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3109 + + String + + jakarta.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName +
+
+
+ Returns the default event name for this ClientBehaviorHolder implementation. This must + be one of the event names returned by #getEventNames or null if the component does not have a + default event. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3110 + + Collection + + jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames +
+
+
+ Returns a non-null, unmodifiable Collection containing the names of the logical events + supported by the component implementing this interface. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3111 + + boolean + + jakarta.faces.component.behavior.FacesBehavior.managed +
+
+
+ The value of this annotation attribute is taken to be an indicator that flags whether + or not the given converter is a CDI managed converter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3112 + + String + + jakarta.faces.component.behavior.FacesBehavior.value +
+
+
+ The value of this annotation attribute is taken to be the behavior-id with which + instances of this class of behavior can be instantiated. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3113 + + boolean + + jakarta.faces.component.behavior.FacesBehavior.Literal.managed +
+
+
+ The value of this annotation attribute is taken to be an indicator that flags whether + or not the given converter is a CDI managed converter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3114 + + Literal + + jakarta.faces.component.behavior.FacesBehavior.Literal.of +
+ ( + String + , +
+ boolean + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3115 + + String + + jakarta.faces.component.behavior.FacesBehavior.Literal.value +
+
+
+ The value of this annotation attribute is taken to be the behavior-id with which + instances of this class of behavior can be instantiated. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3116 + + String + + jakarta.faces.component.html.HtmlBody.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3117 + + String + + jakarta.faces.component.html.HtmlBody.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3118 + + Collection + + jakarta.faces.component.html.HtmlBody.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3119 + + String + + jakarta.faces.component.html.HtmlBody.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3120 + + String + + jakarta.faces.component.html.HtmlBody.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3121 + + String + + jakarta.faces.component.html.HtmlBody.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3122 + + String + + jakarta.faces.component.html.HtmlBody.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3123 + + String + + jakarta.faces.component.html.HtmlBody.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3124 + + String + + jakarta.faces.component.html.HtmlBody.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3125 + + String + + jakarta.faces.component.html.HtmlBody.getOnload +
+
+
+ Return the value of the onload property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3126 + + String + + jakarta.faces.component.html.HtmlBody.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3127 + + String + + jakarta.faces.component.html.HtmlBody.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3128 + + String + + jakarta.faces.component.html.HtmlBody.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3129 + + String + + jakarta.faces.component.html.HtmlBody.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3130 + + String + + jakarta.faces.component.html.HtmlBody.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3131 + + String + + jakarta.faces.component.html.HtmlBody.getOnunload +
+
+
+ Return the value of the onunload property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3132 + + String + + jakarta.faces.component.html.HtmlBody.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3133 + + String + + jakarta.faces.component.html.HtmlBody.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3134 + + String + + jakarta.faces.component.html.HtmlBody.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3135 + + String + + jakarta.faces.component.html.HtmlBody.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3136 + + String + + jakarta.faces.component.html.HtmlBody.getXmlns +
+
+
+ Return the value of the xmlns property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3137 + + HtmlBody + + jakarta.faces.component.html.HtmlBody.HtmlBody +
+
+
+ Default constructor setting the renderer type. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3138 + + void + + jakarta.faces.component.html.HtmlBody.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3139 + + void + + jakarta.faces.component.html.HtmlBody.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3140 + + void + + jakarta.faces.component.html.HtmlBody.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3141 + + void + + jakarta.faces.component.html.HtmlBody.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3142 + + void + + jakarta.faces.component.html.HtmlBody.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3143 + + void + + jakarta.faces.component.html.HtmlBody.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3144 + + void + + jakarta.faces.component.html.HtmlBody.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3145 + + void + + jakarta.faces.component.html.HtmlBody.setOnload +
+ ( + String + ) +
+
+ Set the value of the onload property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3146 + + void + + jakarta.faces.component.html.HtmlBody.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3147 + + void + + jakarta.faces.component.html.HtmlBody.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3148 + + void + + jakarta.faces.component.html.HtmlBody.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3149 + + void + + jakarta.faces.component.html.HtmlBody.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3150 + + void + + jakarta.faces.component.html.HtmlBody.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3151 + + void + + jakarta.faces.component.html.HtmlBody.setOnunload +
+ ( + String + ) +
+
+ Set the value of the onunload property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3152 + + void + + jakarta.faces.component.html.HtmlBody.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3153 + + void + + jakarta.faces.component.html.HtmlBody.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3154 + + void + + jakarta.faces.component.html.HtmlBody.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3155 + + void + + jakarta.faces.component.html.HtmlBody.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3156 + + void + + jakarta.faces.component.html.HtmlBody.setXmlns +
+ ( + String + ) +
+
+ Set the value of the xmlns property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3157 + + String + + jakarta.faces.component.html.HtmlBody.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3158 + + PropertyKeys + + jakarta.faces.component.html.HtmlBody.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3159 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlBody.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3160 + + String + + jakarta.faces.component.html.HtmlColumn.getFooterClass +
+
+
+ Return the value of the footerClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3161 + + String + + jakarta.faces.component.html.HtmlColumn.getHeaderClass +
+
+
+ Return the value of the headerClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3162 + + String + + jakarta.faces.component.html.HtmlColumn.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3163 + + HtmlColumn + + jakarta.faces.component.html.HtmlColumn.HtmlColumn +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3164 + + boolean + + jakarta.faces.component.html.HtmlColumn.isRowHeader +
+
+
+ Return the value of the rowHeader property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3165 + + void + + jakarta.faces.component.html.HtmlColumn.setFooterClass +
+ ( + String + ) +
+
+ Set the value of the footerClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3166 + + void + + jakarta.faces.component.html.HtmlColumn.setHeaderClass +
+ ( + String + ) +
+
+ Set the value of the headerClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3167 + + void + + jakarta.faces.component.html.HtmlColumn.setRowHeader +
+ ( + boolean + ) +
+
+ Set the value of the rowHeader property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3168 + + void + + jakarta.faces.component.html.HtmlColumn.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3169 + + String + + jakarta.faces.component.html.HtmlColumn.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3170 + + PropertyKeys + + jakarta.faces.component.html.HtmlColumn.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3171 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlColumn.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3172 + + String + + jakarta.faces.component.html.HtmlCommandButton.getAccesskey +
+
+
+ Return the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3173 + + String + + jakarta.faces.component.html.HtmlCommandButton.getAlt +
+
+
+ Return the value of the alt property. This attribute is ignored when the image + attribute is not specified. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3174 + + String + + jakarta.faces.component.html.HtmlCommandButton.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3175 + + String + + jakarta.faces.component.html.HtmlCommandButton.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3176 + + Collection + + jakarta.faces.component.html.HtmlCommandButton.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3177 + + String + + jakarta.faces.component.html.HtmlCommandButton.getImage +
+
+
+ Return the value of the image property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3178 + + String + + jakarta.faces.component.html.HtmlCommandButton.getLabel +
+
+
+ Return the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3179 + + String + + jakarta.faces.component.html.HtmlCommandButton.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3180 + + String + + jakarta.faces.component.html.HtmlCommandButton.getOnblur +
+
+
+ Return the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3181 + + String + + jakarta.faces.component.html.HtmlCommandButton.getOnchange +
+
+
+ Return the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3182 + + String + + jakarta.faces.component.html.HtmlCommandButton.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3183 + + String + + jakarta.faces.component.html.HtmlCommandButton.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3184 + + String + + jakarta.faces.component.html.HtmlCommandButton.getOnfocus +
+
+
+ Return the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3185 + + String + + jakarta.faces.component.html.HtmlCommandButton.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3186 + + String + + jakarta.faces.component.html.HtmlCommandButton.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3187 + + String + + jakarta.faces.component.html.HtmlCommandButton.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3188 + + String + + jakarta.faces.component.html.HtmlCommandButton.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3189 + + String + + jakarta.faces.component.html.HtmlCommandButton.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3190 + + String + + jakarta.faces.component.html.HtmlCommandButton.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3191 + + String + + jakarta.faces.component.html.HtmlCommandButton.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3192 + + String + + jakarta.faces.component.html.HtmlCommandButton.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3193 + + String + + jakarta.faces.component.html.HtmlCommandButton.getOnselect +
+
+
+ Return the value of the onselect property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3194 + + String + + jakarta.faces.component.html.HtmlCommandButton.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3195 + + String + + jakarta.faces.component.html.HtmlCommandButton.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3196 + + String + + jakarta.faces.component.html.HtmlCommandButton.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3197 + + String + + jakarta.faces.component.html.HtmlCommandButton.getTabindex +
+
+
+ Return the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3198 + + String + + jakarta.faces.component.html.HtmlCommandButton.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3199 + + String + + jakarta.faces.component.html.HtmlCommandButton.getType +
+
+
+ Return the value of the type property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3200 + + HtmlCommandButton + + jakarta.faces.component.html.HtmlCommandButton.HtmlCommandButton +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3201 + + boolean + + jakarta.faces.component.html.HtmlCommandButton.isDisabled +
+
+
+ Return the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3202 + + boolean + + jakarta.faces.component.html.HtmlCommandButton.isReadonly +
+
+
+ Return the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3203 + + void + + jakarta.faces.component.html.HtmlCommandButton.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3204 + + void + + jakarta.faces.component.html.HtmlCommandButton.setAlt +
+ ( + String + ) +
+
+ Set the value of the alt property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3205 + + void + + jakarta.faces.component.html.HtmlCommandButton.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3206 + + void + + jakarta.faces.component.html.HtmlCommandButton.setDisabled +
+ ( + boolean + ) +
+
+ Set the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3207 + + void + + jakarta.faces.component.html.HtmlCommandButton.setImage +
+ ( + String + ) +
+
+ Set the value of the image property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3208 + + void + + jakarta.faces.component.html.HtmlCommandButton.setLabel +
+ ( + String + ) +
+
+ Set the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3209 + + void + + jakarta.faces.component.html.HtmlCommandButton.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3210 + + void + + jakarta.faces.component.html.HtmlCommandButton.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3211 + + void + + jakarta.faces.component.html.HtmlCommandButton.setOnchange +
+ ( + String + ) +
+
+ Set the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3212 + + void + + jakarta.faces.component.html.HtmlCommandButton.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3213 + + void + + jakarta.faces.component.html.HtmlCommandButton.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3214 + + void + + jakarta.faces.component.html.HtmlCommandButton.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3215 + + void + + jakarta.faces.component.html.HtmlCommandButton.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3216 + + void + + jakarta.faces.component.html.HtmlCommandButton.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3217 + + void + + jakarta.faces.component.html.HtmlCommandButton.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3218 + + void + + jakarta.faces.component.html.HtmlCommandButton.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3219 + + void + + jakarta.faces.component.html.HtmlCommandButton.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3220 + + void + + jakarta.faces.component.html.HtmlCommandButton.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3221 + + void + + jakarta.faces.component.html.HtmlCommandButton.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3222 + + void + + jakarta.faces.component.html.HtmlCommandButton.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3223 + + void + + jakarta.faces.component.html.HtmlCommandButton.setOnselect +
+ ( + String + ) +
+
+ Set the value of the onselect property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3224 + + void + + jakarta.faces.component.html.HtmlCommandButton.setReadonly +
+ ( + boolean + ) +
+
+ Set the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3225 + + void + + jakarta.faces.component.html.HtmlCommandButton.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3226 + + void + + jakarta.faces.component.html.HtmlCommandButton.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3227 + + void + + jakarta.faces.component.html.HtmlCommandButton.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3228 + + void + + jakarta.faces.component.html.HtmlCommandButton.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3229 + + void + + jakarta.faces.component.html.HtmlCommandButton.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3230 + + void + + jakarta.faces.component.html.HtmlCommandButton.setType +
+ ( + String + ) +
+
+ Set the value of the type property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3231 + + String + + jakarta.faces.component.html.HtmlCommandButton.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3232 + + PropertyKeys + + jakarta.faces.component.html.HtmlCommandButton.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3233 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlCommandButton.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3234 + + String + + jakarta.faces.component.html.HtmlCommandLink.getAccesskey +
+
+
+ Return the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3235 + + String + + jakarta.faces.component.html.HtmlCommandLink.getCharset +
+
+
+ Return the value of the charset property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3236 + + String + + jakarta.faces.component.html.HtmlCommandLink.getCoords +
+
+
+ Return the value of the coords property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3237 + + String + + jakarta.faces.component.html.HtmlCommandLink.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3238 + + String + + jakarta.faces.component.html.HtmlCommandLink.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3239 + + Collection + + jakarta.faces.component.html.HtmlCommandLink.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3240 + + String + + jakarta.faces.component.html.HtmlCommandLink.getHreflang +
+
+
+ Return the value of the hreflang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3241 + + String + + jakarta.faces.component.html.HtmlCommandLink.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3242 + + String + + jakarta.faces.component.html.HtmlCommandLink.getOnblur +
+
+
+ Return the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3243 + + String + + jakarta.faces.component.html.HtmlCommandLink.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3244 + + String + + jakarta.faces.component.html.HtmlCommandLink.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3245 + + String + + jakarta.faces.component.html.HtmlCommandLink.getOnfocus +
+
+
+ Return the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3246 + + String + + jakarta.faces.component.html.HtmlCommandLink.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3247 + + String + + jakarta.faces.component.html.HtmlCommandLink.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3248 + + String + + jakarta.faces.component.html.HtmlCommandLink.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3249 + + String + + jakarta.faces.component.html.HtmlCommandLink.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3250 + + String + + jakarta.faces.component.html.HtmlCommandLink.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3251 + + String + + jakarta.faces.component.html.HtmlCommandLink.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3252 + + String + + jakarta.faces.component.html.HtmlCommandLink.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3253 + + String + + jakarta.faces.component.html.HtmlCommandLink.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3254 + + String + + jakarta.faces.component.html.HtmlCommandLink.getRel +
+
+
+ Return the value of the rel property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3255 + + String + + jakarta.faces.component.html.HtmlCommandLink.getRev +
+
+
+ Return the value of the rev property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3256 + + String + + jakarta.faces.component.html.HtmlCommandLink.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3257 + + String + + jakarta.faces.component.html.HtmlCommandLink.getShape +
+
+
+ Return the value of the shape property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3258 + + String + + jakarta.faces.component.html.HtmlCommandLink.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3259 + + String + + jakarta.faces.component.html.HtmlCommandLink.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3260 + + String + + jakarta.faces.component.html.HtmlCommandLink.getTabindex +
+
+
+ Return the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3261 + + String + + jakarta.faces.component.html.HtmlCommandLink.getTarget +
+
+
+ Return the value of the target property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3262 + + String + + jakarta.faces.component.html.HtmlCommandLink.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3263 + + String + + jakarta.faces.component.html.HtmlCommandLink.getType +
+
+
+ Return the value of the type property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3264 + + HtmlCommandLink + + jakarta.faces.component.html.HtmlCommandLink.HtmlCommandLink +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3265 + + boolean + + jakarta.faces.component.html.HtmlCommandLink.isDisabled +
+
+
+ Return the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3266 + + void + + jakarta.faces.component.html.HtmlCommandLink.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3267 + + void + + jakarta.faces.component.html.HtmlCommandLink.setCharset +
+ ( + String + ) +
+
+ Set the value of the charset property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3268 + + void + + jakarta.faces.component.html.HtmlCommandLink.setCoords +
+ ( + String + ) +
+
+ Set the value of the coords property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3269 + + void + + jakarta.faces.component.html.HtmlCommandLink.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3270 + + void + + jakarta.faces.component.html.HtmlCommandLink.setDisabled +
+ ( + boolean + ) +
+
+ Set the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3271 + + void + + jakarta.faces.component.html.HtmlCommandLink.setHreflang +
+ ( + String + ) +
+
+ Set the value of the hreflang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3272 + + void + + jakarta.faces.component.html.HtmlCommandLink.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3273 + + void + + jakarta.faces.component.html.HtmlCommandLink.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3274 + + void + + jakarta.faces.component.html.HtmlCommandLink.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3275 + + void + + jakarta.faces.component.html.HtmlCommandLink.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3276 + + void + + jakarta.faces.component.html.HtmlCommandLink.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3277 + + void + + jakarta.faces.component.html.HtmlCommandLink.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3278 + + void + + jakarta.faces.component.html.HtmlCommandLink.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3279 + + void + + jakarta.faces.component.html.HtmlCommandLink.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3280 + + void + + jakarta.faces.component.html.HtmlCommandLink.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3281 + + void + + jakarta.faces.component.html.HtmlCommandLink.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3282 + + void + + jakarta.faces.component.html.HtmlCommandLink.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3283 + + void + + jakarta.faces.component.html.HtmlCommandLink.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3284 + + void + + jakarta.faces.component.html.HtmlCommandLink.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3285 + + void + + jakarta.faces.component.html.HtmlCommandLink.setRel +
+ ( + String + ) +
+
+ Set the value of the rel property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3286 + + void + + jakarta.faces.component.html.HtmlCommandLink.setRev +
+ ( + String + ) +
+
+ Set the value of the rev property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3287 + + void + + jakarta.faces.component.html.HtmlCommandLink.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3288 + + void + + jakarta.faces.component.html.HtmlCommandLink.setShape +
+ ( + String + ) +
+
+ Set the value of the shape property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3289 + + void + + jakarta.faces.component.html.HtmlCommandLink.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3290 + + void + + jakarta.faces.component.html.HtmlCommandLink.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3291 + + void + + jakarta.faces.component.html.HtmlCommandLink.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3292 + + void + + jakarta.faces.component.html.HtmlCommandLink.setTarget +
+ ( + String + ) +
+
+ Set the value of the target property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3293 + + void + + jakarta.faces.component.html.HtmlCommandLink.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3294 + + void + + jakarta.faces.component.html.HtmlCommandLink.setType +
+ ( + String + ) +
+
+ Set the value of the type property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3295 + + String + + jakarta.faces.component.html.HtmlCommandLink.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3296 + + PropertyKeys + + jakarta.faces.component.html.HtmlCommandLink.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3297 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlCommandLink.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3298 + + String + + jakarta.faces.component.html.HtmlCommandScript.getExecute +
+
+
+ Return the value of the execute property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3299 + + String + + jakarta.faces.component.html.HtmlCommandScript.getName +
+
+
+ Return the value of the name property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3300 + + String + + jakarta.faces.component.html.HtmlCommandScript.getOnerror +
+
+
+ Return the value of the onerror property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3301 + + String + + jakarta.faces.component.html.HtmlCommandScript.getOnevent +
+
+
+ Return the value of the onevent property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3302 + + String + + jakarta.faces.component.html.HtmlCommandScript.getRender +
+
+
+ Return the value of the render property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3303 + + Boolean + + jakarta.faces.component.html.HtmlCommandScript.getResetValues +
+
+
+ Return the value of the resetValues property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3304 + + HtmlCommandScript + + jakarta.faces.component.html.HtmlCommandScript.HtmlCommandScript +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3305 + + boolean + + jakarta.faces.component.html.HtmlCommandScript.isAutorun +
+
+
+ Return the value of the autorun property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3306 + + void + + jakarta.faces.component.html.HtmlCommandScript.setAutorun +
+ ( + boolean + ) +
+
+ Set the value of the autorun property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3307 + + void + + jakarta.faces.component.html.HtmlCommandScript.setExecute +
+ ( + String + ) +
+
+ Set the value of the execute property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3308 + + void + + jakarta.faces.component.html.HtmlCommandScript.setName +
+ ( + String + ) +
+
+ Set the value of the name property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3309 + + void + + jakarta.faces.component.html.HtmlCommandScript.setOnerror +
+ ( + String + ) +
+
+ Set the value of the onerror property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3310 + + void + + jakarta.faces.component.html.HtmlCommandScript.setOnevent +
+ ( + String + ) +
+
+ Set the value of the onevent property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3311 + + void + + jakarta.faces.component.html.HtmlCommandScript.setRender +
+ ( + String + ) +
+
+ Set the value of the render property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3312 + + void + + jakarta.faces.component.html.HtmlCommandScript.setResetValues +
+ ( + Boolean + ) +
+
+ Set the value of the resetValues property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3313 + + String + + jakarta.faces.component.html.HtmlCommandScript.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3314 + + PropertyKeys + + jakarta.faces.component.html.HtmlCommandScript.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3315 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlCommandScript.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3316 + + String + + jakarta.faces.component.html.HtmlDataTable.getBgcolor +
+
+
+ Return the value of the bgcolor property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3317 + + String + + jakarta.faces.component.html.HtmlDataTable.getBodyrows +
+
+
+ Return the value of the bodyrows property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3318 + + int + + jakarta.faces.component.html.HtmlDataTable.getBorder +
+
+
+ Return the value of the border property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3319 + + String + + jakarta.faces.component.html.HtmlDataTable.getCaptionClass +
+
+
+ Return the value of the captionClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3320 + + String + + jakarta.faces.component.html.HtmlDataTable.getCaptionStyle +
+
+
+ Return the value of the captionStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3321 + + String + + jakarta.faces.component.html.HtmlDataTable.getCellpadding +
+
+
+ Return the value of the cellpadding property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3322 + + String + + jakarta.faces.component.html.HtmlDataTable.getCellspacing +
+
+
+ Return the value of the cellspacing property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3323 + + String + + jakarta.faces.component.html.HtmlDataTable.getColumnClasses +
+
+
+ Return the value of the columnClasses property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3324 + + String + + jakarta.faces.component.html.HtmlDataTable.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3325 + + String + + jakarta.faces.component.html.HtmlDataTable.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3326 + + Collection + + jakarta.faces.component.html.HtmlDataTable.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3327 + + String + + jakarta.faces.component.html.HtmlDataTable.getFooterClass +
+
+
+ Return the value of the footerClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3328 + + String + + jakarta.faces.component.html.HtmlDataTable.getFrame +
+
+
+ Return the value of the frame property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3329 + + String + + jakarta.faces.component.html.HtmlDataTable.getHeaderClass +
+
+
+ Return the value of the headerClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3330 + + String + + jakarta.faces.component.html.HtmlDataTable.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3331 + + String + + jakarta.faces.component.html.HtmlDataTable.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3332 + + String + + jakarta.faces.component.html.HtmlDataTable.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3333 + + String + + jakarta.faces.component.html.HtmlDataTable.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3334 + + String + + jakarta.faces.component.html.HtmlDataTable.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3335 + + String + + jakarta.faces.component.html.HtmlDataTable.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3336 + + String + + jakarta.faces.component.html.HtmlDataTable.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3337 + + String + + jakarta.faces.component.html.HtmlDataTable.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3338 + + String + + jakarta.faces.component.html.HtmlDataTable.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3339 + + String + + jakarta.faces.component.html.HtmlDataTable.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3340 + + String + + jakarta.faces.component.html.HtmlDataTable.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3341 + + String + + jakarta.faces.component.html.HtmlDataTable.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3342 + + String + + jakarta.faces.component.html.HtmlDataTable.getRowClass +
+
+
+ Return the value of the rowClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3343 + + String + + jakarta.faces.component.html.HtmlDataTable.getRowClasses +
+
+
+ Return the value of the rowClasses property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3344 + + String + + jakarta.faces.component.html.HtmlDataTable.getRules +
+
+
+ Return the value of the rules property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3345 + + String + + jakarta.faces.component.html.HtmlDataTable.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3346 + + String + + jakarta.faces.component.html.HtmlDataTable.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3347 + + String + + jakarta.faces.component.html.HtmlDataTable.getSummary +
+
+
+ Return the value of the summary property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3348 + + String + + jakarta.faces.component.html.HtmlDataTable.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3349 + + String + + jakarta.faces.component.html.HtmlDataTable.getWidth +
+
+
+ Return the value of the width property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3350 + + HtmlDataTable + + jakarta.faces.component.html.HtmlDataTable.HtmlDataTable +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3351 + + void + + jakarta.faces.component.html.HtmlDataTable.setBgcolor +
+ ( + String + ) +
+
+ Set the value of the bgcolor property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3352 + + void + + jakarta.faces.component.html.HtmlDataTable.setBodyrows +
+ ( + String + ) +
+
+ Set the value of the bodyrows property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3353 + + void + + jakarta.faces.component.html.HtmlDataTable.setBorder +
+ ( + int + ) +
+
+ Set the value of the border property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3354 + + void + + jakarta.faces.component.html.HtmlDataTable.setCaptionClass +
+ ( + String + ) +
+
+ Set the value of the captionClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3355 + + void + + jakarta.faces.component.html.HtmlDataTable.setCaptionStyle +
+ ( + String + ) +
+
+ Set the value of the captionStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3356 + + void + + jakarta.faces.component.html.HtmlDataTable.setCellpadding +
+ ( + String + ) +
+
+ Set the value of the cellpadding property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3357 + + void + + jakarta.faces.component.html.HtmlDataTable.setCellspacing +
+ ( + String + ) +
+
+ Set the value of the cellspacing property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3358 + + void + + jakarta.faces.component.html.HtmlDataTable.setColumnClasses +
+ ( + String + ) +
+
+ Set the value of the columnClasses property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3359 + + void + + jakarta.faces.component.html.HtmlDataTable.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3360 + + void + + jakarta.faces.component.html.HtmlDataTable.setFooterClass +
+ ( + String + ) +
+
+ Set the value of the footerClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3361 + + void + + jakarta.faces.component.html.HtmlDataTable.setFrame +
+ ( + String + ) +
+
+ Set the value of the frame property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3362 + + void + + jakarta.faces.component.html.HtmlDataTable.setHeaderClass +
+ ( + String + ) +
+
+ Set the value of the headerClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3363 + + void + + jakarta.faces.component.html.HtmlDataTable.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3364 + + void + + jakarta.faces.component.html.HtmlDataTable.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3365 + + void + + jakarta.faces.component.html.HtmlDataTable.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3366 + + void + + jakarta.faces.component.html.HtmlDataTable.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3367 + + void + + jakarta.faces.component.html.HtmlDataTable.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3368 + + void + + jakarta.faces.component.html.HtmlDataTable.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3369 + + void + + jakarta.faces.component.html.HtmlDataTable.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3370 + + void + + jakarta.faces.component.html.HtmlDataTable.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3371 + + void + + jakarta.faces.component.html.HtmlDataTable.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3372 + + void + + jakarta.faces.component.html.HtmlDataTable.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3373 + + void + + jakarta.faces.component.html.HtmlDataTable.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3374 + + void + + jakarta.faces.component.html.HtmlDataTable.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3375 + + void + + jakarta.faces.component.html.HtmlDataTable.setRowClass +
+ ( + String + ) +
+
+ Set the value of the rowClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3376 + + void + + jakarta.faces.component.html.HtmlDataTable.setRowClasses +
+ ( + String + ) +
+
+ Set the value of the rowClasses property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3377 + + void + + jakarta.faces.component.html.HtmlDataTable.setRules +
+ ( + String + ) +
+
+ Set the value of the rules property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3378 + + void + + jakarta.faces.component.html.HtmlDataTable.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3379 + + void + + jakarta.faces.component.html.HtmlDataTable.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3380 + + void + + jakarta.faces.component.html.HtmlDataTable.setSummary +
+ ( + String + ) +
+
+ Set the value of the summary property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3381 + + void + + jakarta.faces.component.html.HtmlDataTable.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3382 + + void + + jakarta.faces.component.html.HtmlDataTable.setWidth +
+ ( + String + ) +
+
+ Set the value of the width property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3383 + + String + + jakarta.faces.component.html.HtmlDataTable.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3384 + + PropertyKeys + + jakarta.faces.component.html.HtmlDataTable.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3385 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlDataTable.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3386 + + String + + jakarta.faces.component.html.HtmlDoctype.getPublic +
+
+
+ Return the value of the public property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3387 + + String + + jakarta.faces.component.html.HtmlDoctype.getRootElement +
+
+
+ Return the value of the rootElement property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3388 + + String + + jakarta.faces.component.html.HtmlDoctype.getSystem +
+
+
+ Return the value of the system property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3389 + + HtmlDoctype + + jakarta.faces.component.html.HtmlDoctype.HtmlDoctype +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3390 + + void + + jakarta.faces.component.html.HtmlDoctype.setPublic +
+ ( + String + ) +
+
+ Set the value of the public property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3391 + + void + + jakarta.faces.component.html.HtmlDoctype.setRootElement +
+ ( + String + ) +
+
+ Set the value of the rootElement property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3392 + + void + + jakarta.faces.component.html.HtmlDoctype.setSystem +
+ ( + String + ) +
+
+ Set the value of the system property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3393 + + String + + jakarta.faces.component.html.HtmlDoctype.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3394 + + PropertyKeys + + jakarta.faces.component.html.HtmlDoctype.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3395 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlDoctype.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3396 + + String + + jakarta.faces.component.html.HtmlForm.getAccept +
+
+
+ Return the value of the accept property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3397 + + String + + jakarta.faces.component.html.HtmlForm.getAcceptcharset +
+
+
+ Return the value of the acceptcharset property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3398 + + String + + jakarta.faces.component.html.HtmlForm.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3399 + + String + + jakarta.faces.component.html.HtmlForm.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3400 + + String + + jakarta.faces.component.html.HtmlForm.getEnctype +
+
+
+ Return the value of the enctype property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3401 + + Collection + + jakarta.faces.component.html.HtmlForm.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3402 + + String + + jakarta.faces.component.html.HtmlForm.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3403 + + String + + jakarta.faces.component.html.HtmlForm.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3404 + + String + + jakarta.faces.component.html.HtmlForm.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3405 + + String + + jakarta.faces.component.html.HtmlForm.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3406 + + String + + jakarta.faces.component.html.HtmlForm.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3407 + + String + + jakarta.faces.component.html.HtmlForm.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3408 + + String + + jakarta.faces.component.html.HtmlForm.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3409 + + String + + jakarta.faces.component.html.HtmlForm.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3410 + + String + + jakarta.faces.component.html.HtmlForm.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3411 + + String + + jakarta.faces.component.html.HtmlForm.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3412 + + String + + jakarta.faces.component.html.HtmlForm.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3413 + + String + + jakarta.faces.component.html.HtmlForm.getOnreset +
+
+
+ Return the value of the onreset property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3414 + + String + + jakarta.faces.component.html.HtmlForm.getOnsubmit +
+
+
+ Return the value of the onsubmit property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3415 + + String + + jakarta.faces.component.html.HtmlForm.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3416 + + String + + jakarta.faces.component.html.HtmlForm.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3417 + + String + + jakarta.faces.component.html.HtmlForm.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3418 + + String + + jakarta.faces.component.html.HtmlForm.getTarget +
+
+
+ Return the value of the target property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3419 + + String + + jakarta.faces.component.html.HtmlForm.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3420 + + HtmlForm + + jakarta.faces.component.html.HtmlForm.HtmlForm +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3421 + + void + + jakarta.faces.component.html.HtmlForm.setAccept +
+ ( + String + ) +
+
+ Set the value of the accept property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3422 + + void + + jakarta.faces.component.html.HtmlForm.setAcceptcharset +
+ ( + String + ) +
+
+ Set the value of the acceptcharset property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3423 + + void + + jakarta.faces.component.html.HtmlForm.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3424 + + void + + jakarta.faces.component.html.HtmlForm.setEnctype +
+ ( + String + ) +
+
+ Set the value of the enctype property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3425 + + void + + jakarta.faces.component.html.HtmlForm.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3426 + + void + + jakarta.faces.component.html.HtmlForm.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3427 + + void + + jakarta.faces.component.html.HtmlForm.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3428 + + void + + jakarta.faces.component.html.HtmlForm.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3429 + + void + + jakarta.faces.component.html.HtmlForm.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3430 + + void + + jakarta.faces.component.html.HtmlForm.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3431 + + void + + jakarta.faces.component.html.HtmlForm.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3432 + + void + + jakarta.faces.component.html.HtmlForm.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3433 + + void + + jakarta.faces.component.html.HtmlForm.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3434 + + void + + jakarta.faces.component.html.HtmlForm.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3435 + + void + + jakarta.faces.component.html.HtmlForm.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3436 + + void + + jakarta.faces.component.html.HtmlForm.setOnreset +
+ ( + String + ) +
+
+ Set the value of the onreset property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3437 + + void + + jakarta.faces.component.html.HtmlForm.setOnsubmit +
+ ( + String + ) +
+
+ Set the value of the onsubmit property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3438 + + void + + jakarta.faces.component.html.HtmlForm.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3439 + + void + + jakarta.faces.component.html.HtmlForm.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3440 + + void + + jakarta.faces.component.html.HtmlForm.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3441 + + void + + jakarta.faces.component.html.HtmlForm.setTarget +
+ ( + String + ) +
+
+ Set the value of the target property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3442 + + void + + jakarta.faces.component.html.HtmlForm.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3443 + + String + + jakarta.faces.component.html.HtmlForm.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3444 + + PropertyKeys + + jakarta.faces.component.html.HtmlForm.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3445 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlForm.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3446 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getAlt +
+
+
+ Return the value of the alt property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3447 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3448 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3449 + + Collection + + jakarta.faces.component.html.HtmlGraphicImage.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3450 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getHeight +
+
+
+ Return the value of the height property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3451 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3452 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getLongdesc +
+
+
+ Return the value of the longdesc property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3453 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3454 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3455 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3456 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3457 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3458 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3459 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3460 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3461 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3462 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3463 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3464 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3465 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3466 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3467 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getUsemap +
+
+
+ Return the value of the usemap property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3468 + + String + + jakarta.faces.component.html.HtmlGraphicImage.getWidth +
+
+
+ Return the value of the width property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3469 + + HtmlGraphicImage + + jakarta.faces.component.html.HtmlGraphicImage.HtmlGraphicImage +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3470 + + boolean + + jakarta.faces.component.html.HtmlGraphicImage.isIsmap +
+
+
+ Return the value of the ismap property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3471 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setAlt +
+ ( + String + ) +
+
+ Set the value of the alt property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3472 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3473 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setHeight +
+ ( + String + ) +
+
+ Set the value of the height property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3474 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setIsmap +
+ ( + boolean + ) +
+
+ Set the value of the ismap property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3475 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3476 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setLongdesc +
+ ( + String + ) +
+
+ Set the value of the longdesc property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3477 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3478 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3479 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3480 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3481 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3482 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3483 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3484 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3485 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3486 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3487 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3488 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3489 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3490 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3491 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setUsemap +
+ ( + String + ) +
+
+ Set the value of the usemap property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3492 + + void + + jakarta.faces.component.html.HtmlGraphicImage.setWidth +
+ ( + String + ) +
+
+ Set the value of the width property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3493 + + String + + jakarta.faces.component.html.HtmlGraphicImage.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3494 + + PropertyKeys + + jakarta.faces.component.html.HtmlGraphicImage.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3495 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlGraphicImage.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3496 + + String + + jakarta.faces.component.html.HtmlHead.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3497 + + String + + jakarta.faces.component.html.HtmlHead.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3498 + + String + + jakarta.faces.component.html.HtmlHead.getXmlns +
+
+
+ Return the value of the xmlns property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3499 + + HtmlHead + + jakarta.faces.component.html.HtmlHead.HtmlHead +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3500 + + void + + jakarta.faces.component.html.HtmlHead.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3501 + + void + + jakarta.faces.component.html.HtmlHead.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3502 + + void + + jakarta.faces.component.html.HtmlHead.setXmlns +
+ ( + String + ) +
+
+ Set the value of the xmlns property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3503 + + String + + jakarta.faces.component.html.HtmlHead.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3504 + + PropertyKeys + + jakarta.faces.component.html.HtmlHead.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3505 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlHead.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3506 + + String + + jakarta.faces.component.html.HtmlInputFile.getAccept +
+
+
+ Return the value of the accept property. Contents: Comma separated string of mime types + of files to filter in client side file browse dialog. Note: This is not validated in server side. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3507 + + String + + jakarta.faces.component.html.HtmlInputFile.getAccesskey +
+
+
+ Return the value of the accesskey property. Contents: Access key that, when pressed, + transfers focus to this element. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3508 + + String + + jakarta.faces.component.html.HtmlInputFile.getAlt +
+
+
+ Return the value of the alt property. Contents: Alternate textual description of the + element rendered by this component. + + true + + true + + true +
+ JSF:JAVADOC:3509 + + String + + jakarta.faces.component.html.HtmlInputFile.getAutocomplete +
+
+
+ Return the value of the autocomplete property. Contents: If the value of this attribute + is "off", render "off" as the value of the attribute. This indicates that the browser should disable + its autocomplete feature for this component. This is useful for components that perform + autocompletion and do not want the browser interfering. If this attribute is not set or the value is + "on", render nothing. + + true + + true + + true +
+ JSF:JAVADOC:3510 + + String + + jakarta.faces.component.html.HtmlInputFile.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3511 + + String + + jakarta.faces.component.html.HtmlInputFile.getDir +
+
+
+ Return the value of the dir property. Contents: Direction indication for text that does + not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). These + attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct + case. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3512 + + Collection + + jakarta.faces.component.html.HtmlInputFile.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3513 + + String + + jakarta.faces.component.html.HtmlInputFile.getLabel +
+
+
+ Return the value of the label property. Contents: A localized user presentable name for + this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3514 + + String + + jakarta.faces.component.html.HtmlInputFile.getLang +
+
+
+ Return the value of the lang property. Contents: Code describing the language used in + the generated markup for this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3515 + + int + + jakarta.faces.component.html.HtmlInputFile.getMaxlength +
+
+
+ Return the value of the maxlength property. Contents: The maximum number of characters + that may be entered in this field. + + true + + true + + true +
+ JSF:JAVADOC:3516 + + String + + jakarta.faces.component.html.HtmlInputFile.getOnblur +
+
+
+ Return the value of the onblur property. Contents: JavaScript code executed when this + element loses focus. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3517 + + String + + jakarta.faces.component.html.HtmlInputFile.getOnchange +
+
+
+ Return the value of the onchange property. Contents: JavaScript code executed when this + element loses focus and its value has been modified since gaining focus. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3518 + + String + + jakarta.faces.component.html.HtmlInputFile.getOnclick +
+
+
+ Return the value of the onclick property. Contents: JavaScript code executed when a + pointer button is clicked over this element. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3519 + + String + + jakarta.faces.component.html.HtmlInputFile.getOndblclick +
+
+
+ Return the value of the ondblclick property. Contents: JavaScript code executed when a + pointer button is double clicked over this element. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3520 + + String + + jakarta.faces.component.html.HtmlInputFile.getOnfocus +
+
+
+ Return the value of the onfocus property. Contents: JavaScript code executed when this + element receives focus. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3521 + + String + + jakarta.faces.component.html.HtmlInputFile.getOnkeydown +
+
+
+ Return the value of the onkeydown property. Contents: JavaScript code executed when a + key is pressed down over this element. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3522 + + String + + jakarta.faces.component.html.HtmlInputFile.getOnkeypress +
+
+
+ Return the value of the onkeypress property. Contents: JavaScript code executed when a + key is pressed and released over this element. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3523 + + String + + jakarta.faces.component.html.HtmlInputFile.getOnkeyup +
+
+
+ Return the value of the onkeyup property. Contents: JavaScript code executed when a key + is released over this element. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3524 + + String + + jakarta.faces.component.html.HtmlInputFile.getOnmousedown +
+
+
+ Return the value of the onmousedown property. Contents: JavaScript code executed when a + pointer button is pressed down over this element. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3525 + + String + + jakarta.faces.component.html.HtmlInputFile.getOnmousemove +
+
+
+ Return the value of the onmousemove property. Contents: JavaScript code executed when a + pointer button is moved within this element. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3526 + + String + + jakarta.faces.component.html.HtmlInputFile.getOnmouseout +
+
+
+ Return the value of the onmouseout property. Contents: JavaScript code executed when a + pointer button is moved away from this element. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3527 + + String + + jakarta.faces.component.html.HtmlInputFile.getOnmouseover +
+
+
+ Return the value of the onmouseover property. Contents: JavaScript code executed when a + pointer button is moved onto this element. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3528 + + String + + jakarta.faces.component.html.HtmlInputFile.getOnmouseup +
+
+
+ Return the value of the onmouseup property. Contents: JavaScript code executed when a + pointer button is released over this element. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3529 + + String + + jakarta.faces.component.html.HtmlInputFile.getOnselect +
+
+
+ Return the value of the onselect property. Contents: JavaScript code executed when text + within this element is selected by the user. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3530 + + String + + jakarta.faces.component.html.HtmlInputFile.getRole +
+
+
+ Return the value of the role property. Contents: Per the WAI-ARIA spec and its + relationship to HTML5 (Section title ARIA Role Attriubute), every HTML element may have a "role" + attribute whose value must be passed through unmodified on the element on which it is declared in + the final rendered markup. The attribute, if specified, must have a value that is a string literal + that is, or a Jakarta Expression Language Expression that evaluates to, a set of space-separated + tokens representing the various WAI-ARIA roles that the element belongs to. It is the page author's + responsibility to ensure that the user agent is capable of correctly interpreting the value of this + attribute. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3531 + + int + + jakarta.faces.component.html.HtmlInputFile.getSize +
+
+
+ Return the value of the size property. Contents: The number of characters used to + determine the width of this field. + + true + + true + + true +
+ JSF:JAVADOC:3532 + + String + + jakarta.faces.component.html.HtmlInputFile.getStyle +
+
+
+ Return the value of the style property. Contents: CSS style(s) to be applied when this + component is rendered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3533 + + String + + jakarta.faces.component.html.HtmlInputFile.getStyleClass +
+
+
+ Return the value of the styleClass property. Contents: Space-separated list of CSS + style class(es) to be applied when this element is rendered. This value must be passed through as + the "class" attribute on generated markup. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3534 + + String + + jakarta.faces.component.html.HtmlInputFile.getTabindex +
+
+
+ Return the value of the tabindex property. Contents: Position of this element in the + tabbing order for the current document. This value must be an integer between 0 and 32767. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3535 + + String + + jakarta.faces.component.html.HtmlInputFile.getTitle +
+
+
+ Return the value of the title property. Contents: Advisory title information about + markup elements generated for this component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3536 + + HtmlInputFile + + jakarta.faces.component.html.HtmlInputFile.HtmlInputFile +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3537 + + boolean + + jakarta.faces.component.html.HtmlInputFile.isDisabled +
+
+
+ Return the value of the disabled property. Contents: Flag indicating that this element + must never receive focus or be included in a subsequent submit. A value of false causes no attribute + to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled". + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3538 + + boolean + + jakarta.faces.component.html.HtmlInputFile.isMultiple +
+
+
+ Return the value of the multiple property. Contents: Flag indicating that this element + must allow multiple file selection. A value of false causes no attribute to be rendered, while a + value of true causes the attribute to be rendered as multiple="multiple". + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3539 + + boolean + + jakarta.faces.component.html.HtmlInputFile.isReadonly +
+
+
+ Return the value of the readonly property. Contents: Flag indicating that this + component will prohibit changes by the user. The element may receive focus unless it has also been + disabled. A value of false causes no attribute to be rendered, while a value of true causes the + attribute to be rendered as readonly="readonly". + + true + + true + + true +
+ JSF:JAVADOC:3540 + + Object + + jakarta.faces.component.html.HtmlInputFile.saveState +
+ ( + FacesContext + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3541 + + void + + jakarta.faces.component.html.HtmlInputFile.setAccept +
+ ( + String + ) +
+
+ Set the value of the accept property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3542 + + void + + jakarta.faces.component.html.HtmlInputFile.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3543 + + void + + jakarta.faces.component.html.HtmlInputFile.setAlt +
+ ( + String + ) +
+
+ Set the value of the alt property. + + true + + true + + true +
+ JSF:JAVADOC:3544 + + void + + jakarta.faces.component.html.HtmlInputFile.setAutocomplete +
+ ( + String + ) +
+
+ Set the value of the autocomplete property. + + true + + true + + true +
+ JSF:JAVADOC:3545 + + void + + jakarta.faces.component.html.HtmlInputFile.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3546 + + void + + jakarta.faces.component.html.HtmlInputFile.setDisabled +
+ ( + boolean + ) +
+
+ Set the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3547 + + void + + jakarta.faces.component.html.HtmlInputFile.setLabel +
+ ( + String + ) +
+
+ Set the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3548 + + void + + jakarta.faces.component.html.HtmlInputFile.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3549 + + void + + jakarta.faces.component.html.HtmlInputFile.setMaxlength +
+ ( + int + ) +
+
+ Set the value of the maxlength property. + + true + + true + + true +
+ JSF:JAVADOC:3550 + + void + + jakarta.faces.component.html.HtmlInputFile.setMultiple +
+ ( + boolean + ) +
+
+ Set the value of the multiple property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3551 + + void + + jakarta.faces.component.html.HtmlInputFile.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3552 + + void + + jakarta.faces.component.html.HtmlInputFile.setOnchange +
+ ( + String + ) +
+
+ Set the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3553 + + void + + jakarta.faces.component.html.HtmlInputFile.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3554 + + void + + jakarta.faces.component.html.HtmlInputFile.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3555 + + void + + jakarta.faces.component.html.HtmlInputFile.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3556 + + void + + jakarta.faces.component.html.HtmlInputFile.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3557 + + void + + jakarta.faces.component.html.HtmlInputFile.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3558 + + void + + jakarta.faces.component.html.HtmlInputFile.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3559 + + void + + jakarta.faces.component.html.HtmlInputFile.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3560 + + void + + jakarta.faces.component.html.HtmlInputFile.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3561 + + void + + jakarta.faces.component.html.HtmlInputFile.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3562 + + void + + jakarta.faces.component.html.HtmlInputFile.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3563 + + void + + jakarta.faces.component.html.HtmlInputFile.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3564 + + void + + jakarta.faces.component.html.HtmlInputFile.setOnselect +
+ ( + String + ) +
+
+ Set the value of the onselect property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3565 + + void + + jakarta.faces.component.html.HtmlInputFile.setReadonly +
+ ( + boolean + ) +
+
+ Set the value of the readonly property. + + true + + true + + true +
+ JSF:JAVADOC:3566 + + void + + jakarta.faces.component.html.HtmlInputFile.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3567 + + void + + jakarta.faces.component.html.HtmlInputFile.setSize +
+ ( + int + ) +
+
+ Set the value of the size property. + + true + + true + + true +
+ JSF:JAVADOC:3568 + + void + + jakarta.faces.component.html.HtmlInputFile.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3569 + + void + + jakarta.faces.component.html.HtmlInputFile.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3570 + + void + + jakarta.faces.component.html.HtmlInputFile.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3571 + + void + + jakarta.faces.component.html.HtmlInputFile.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3572 + + String + + jakarta.faces.component.html.HtmlInputFile.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3573 + + PropertyKeys + + jakarta.faces.component.html.HtmlInputFile.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3574 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlInputFile.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3575 + + HtmlInputHidden + + jakarta.faces.component.html.HtmlInputHidden.HtmlInputHidden +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3576 + + String + + jakarta.faces.component.html.HtmlInputHidden.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3577 + + PropertyKeys + + jakarta.faces.component.html.HtmlInputHidden.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3578 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlInputHidden.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3579 + + String + + jakarta.faces.component.html.HtmlInputSecret.getAccesskey +
+
+
+ Return the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3580 + + String + + jakarta.faces.component.html.HtmlInputSecret.getAlt +
+
+
+ Return the value of the alt property. + + true + + true + + true +
+ JSF:JAVADOC:3581 + + String + + jakarta.faces.component.html.HtmlInputSecret.getAutocomplete +
+
+
+ Return the value of the autocomplete property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3582 + + String + + jakarta.faces.component.html.HtmlInputSecret.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3583 + + String + + jakarta.faces.component.html.HtmlInputSecret.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3584 + + Collection + + jakarta.faces.component.html.HtmlInputSecret.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3585 + + String + + jakarta.faces.component.html.HtmlInputSecret.getLabel +
+
+
+ Return the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3586 + + String + + jakarta.faces.component.html.HtmlInputSecret.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3587 + + int + + jakarta.faces.component.html.HtmlInputSecret.getMaxlength +
+
+
+ Return the value of the maxlength property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3588 + + String + + jakarta.faces.component.html.HtmlInputSecret.getOnblur +
+
+
+ Return the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3589 + + String + + jakarta.faces.component.html.HtmlInputSecret.getOnchange +
+
+
+ Return the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3590 + + String + + jakarta.faces.component.html.HtmlInputSecret.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3591 + + String + + jakarta.faces.component.html.HtmlInputSecret.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3592 + + String + + jakarta.faces.component.html.HtmlInputSecret.getOnfocus +
+
+
+ Return the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3593 + + String + + jakarta.faces.component.html.HtmlInputSecret.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3594 + + String + + jakarta.faces.component.html.HtmlInputSecret.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3595 + + String + + jakarta.faces.component.html.HtmlInputSecret.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3596 + + String + + jakarta.faces.component.html.HtmlInputSecret.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3597 + + String + + jakarta.faces.component.html.HtmlInputSecret.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3598 + + String + + jakarta.faces.component.html.HtmlInputSecret.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3599 + + String + + jakarta.faces.component.html.HtmlInputSecret.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3600 + + String + + jakarta.faces.component.html.HtmlInputSecret.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3601 + + String + + jakarta.faces.component.html.HtmlInputSecret.getOnselect +
+
+
+ Return the value of the onselect property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3602 + + String + + jakarta.faces.component.html.HtmlInputSecret.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3603 + + int + + jakarta.faces.component.html.HtmlInputSecret.getSize +
+
+
+ Return the value of the size property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3604 + + String + + jakarta.faces.component.html.HtmlInputSecret.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3605 + + String + + jakarta.faces.component.html.HtmlInputSecret.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3606 + + String + + jakarta.faces.component.html.HtmlInputSecret.getTabindex +
+
+
+ Return the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3607 + + String + + jakarta.faces.component.html.HtmlInputSecret.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3608 + + HtmlInputSecret + + jakarta.faces.component.html.HtmlInputSecret.HtmlInputSecret +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3609 + + boolean + + jakarta.faces.component.html.HtmlInputSecret.isDisabled +
+
+
+ Return the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3610 + + boolean + + jakarta.faces.component.html.HtmlInputSecret.isReadonly +
+
+
+ Return the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3611 + + boolean + + jakarta.faces.component.html.HtmlInputSecret.isRedisplay +
+
+
+ Return the value of the redisplay property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3612 + + void + + jakarta.faces.component.html.HtmlInputSecret.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3613 + + void + + jakarta.faces.component.html.HtmlInputSecret.setAlt +
+ ( + String + ) +
+
+ Set the value of the alt property. + + true + + true + + true +
+ JSF:JAVADOC:3614 + + void + + jakarta.faces.component.html.HtmlInputSecret.setAutocomplete +
+ ( + String + ) +
+
+ Set the value of the autocomplete property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3615 + + void + + jakarta.faces.component.html.HtmlInputSecret.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3616 + + void + + jakarta.faces.component.html.HtmlInputSecret.setDisabled +
+ ( + boolean + ) +
+
+ Set the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3617 + + void + + jakarta.faces.component.html.HtmlInputSecret.setLabel +
+ ( + String + ) +
+
+ Set the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3618 + + void + + jakarta.faces.component.html.HtmlInputSecret.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3619 + + void + + jakarta.faces.component.html.HtmlInputSecret.setMaxlength +
+ ( + int + ) +
+
+ Set the value of the maxlength property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3620 + + void + + jakarta.faces.component.html.HtmlInputSecret.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3621 + + void + + jakarta.faces.component.html.HtmlInputSecret.setOnchange +
+ ( + String + ) +
+
+ Set the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3622 + + void + + jakarta.faces.component.html.HtmlInputSecret.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3623 + + void + + jakarta.faces.component.html.HtmlInputSecret.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3624 + + void + + jakarta.faces.component.html.HtmlInputSecret.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3625 + + void + + jakarta.faces.component.html.HtmlInputSecret.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3626 + + void + + jakarta.faces.component.html.HtmlInputSecret.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3627 + + void + + jakarta.faces.component.html.HtmlInputSecret.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3628 + + void + + jakarta.faces.component.html.HtmlInputSecret.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3629 + + void + + jakarta.faces.component.html.HtmlInputSecret.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3630 + + void + + jakarta.faces.component.html.HtmlInputSecret.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3631 + + void + + jakarta.faces.component.html.HtmlInputSecret.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3632 + + void + + jakarta.faces.component.html.HtmlInputSecret.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3633 + + void + + jakarta.faces.component.html.HtmlInputSecret.setOnselect +
+ ( + String + ) +
+
+ Set the value of the onselect property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3634 + + void + + jakarta.faces.component.html.HtmlInputSecret.setReadonly +
+ ( + boolean + ) +
+
+ Set the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3635 + + void + + jakarta.faces.component.html.HtmlInputSecret.setRedisplay +
+ ( + boolean + ) +
+
+ Set the value of the redisplay property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3636 + + void + + jakarta.faces.component.html.HtmlInputSecret.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3637 + + void + + jakarta.faces.component.html.HtmlInputSecret.setSize +
+ ( + int + ) +
+
+ Set the value of the size property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3638 + + void + + jakarta.faces.component.html.HtmlInputSecret.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3639 + + void + + jakarta.faces.component.html.HtmlInputSecret.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3640 + + void + + jakarta.faces.component.html.HtmlInputSecret.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3641 + + void + + jakarta.faces.component.html.HtmlInputSecret.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3642 + + String + + jakarta.faces.component.html.HtmlInputSecret.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3643 + + PropertyKeys + + jakarta.faces.component.html.HtmlInputSecret.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3644 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlInputSecret.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3645 + + String + + jakarta.faces.component.html.HtmlInputText.getAccesskey +
+
+
+ Return the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3646 + + String + + jakarta.faces.component.html.HtmlInputText.getAlt +
+
+
+ Return the value of the alt property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3647 + + String + + jakarta.faces.component.html.HtmlInputText.getAutocomplete +
+
+
+ Return the value of the autocomplete property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3648 + + String + + jakarta.faces.component.html.HtmlInputText.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3649 + + String + + jakarta.faces.component.html.HtmlInputText.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3650 + + Collection + + jakarta.faces.component.html.HtmlInputText.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3651 + + String + + jakarta.faces.component.html.HtmlInputText.getLabel +
+
+
+ Return the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3652 + + String + + jakarta.faces.component.html.HtmlInputText.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3653 + + int + + jakarta.faces.component.html.HtmlInputText.getMaxlength +
+
+
+ Return the value of the maxlength property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3654 + + String + + jakarta.faces.component.html.HtmlInputText.getOnblur +
+
+
+ Return the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3655 + + String + + jakarta.faces.component.html.HtmlInputText.getOnchange +
+
+
+ Return the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3656 + + String + + jakarta.faces.component.html.HtmlInputText.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3657 + + String + + jakarta.faces.component.html.HtmlInputText.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3658 + + String + + jakarta.faces.component.html.HtmlInputText.getOnfocus +
+
+
+ Return the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3659 + + String + + jakarta.faces.component.html.HtmlInputText.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3660 + + String + + jakarta.faces.component.html.HtmlInputText.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3661 + + String + + jakarta.faces.component.html.HtmlInputText.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3662 + + String + + jakarta.faces.component.html.HtmlInputText.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3663 + + String + + jakarta.faces.component.html.HtmlInputText.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3664 + + String + + jakarta.faces.component.html.HtmlInputText.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3665 + + String + + jakarta.faces.component.html.HtmlInputText.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3666 + + String + + jakarta.faces.component.html.HtmlInputText.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3667 + + String + + jakarta.faces.component.html.HtmlInputText.getOnselect +
+
+
+ Return the value of the onselect property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3668 + + String + + jakarta.faces.component.html.HtmlInputText.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3669 + + int + + jakarta.faces.component.html.HtmlInputText.getSize +
+
+
+ Return the value of the size property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3670 + + String + + jakarta.faces.component.html.HtmlInputText.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3671 + + String + + jakarta.faces.component.html.HtmlInputText.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3672 + + String + + jakarta.faces.component.html.HtmlInputText.getTabindex +
+
+
+ Return the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3673 + + String + + jakarta.faces.component.html.HtmlInputText.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3674 + + String + + jakarta.faces.component.html.HtmlInputText.getType +
+
+
+ Return the value of the type property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3675 + + HtmlInputText + + jakarta.faces.component.html.HtmlInputText.HtmlInputText +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3676 + + boolean + + jakarta.faces.component.html.HtmlInputText.isDisabled +
+
+
+ Return the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3677 + + boolean + + jakarta.faces.component.html.HtmlInputText.isReadonly +
+
+
+ Return the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3678 + + void + + jakarta.faces.component.html.HtmlInputText.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3679 + + void + + jakarta.faces.component.html.HtmlInputText.setAlt +
+ ( + String + ) +
+
+ Set the value of the alt property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3680 + + void + + jakarta.faces.component.html.HtmlInputText.setAutocomplete +
+ ( + String + ) +
+
+ Set the value of the autocomplete property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3681 + + void + + jakarta.faces.component.html.HtmlInputText.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3682 + + void + + jakarta.faces.component.html.HtmlInputText.setDisabled +
+ ( + boolean + ) +
+
+ Set the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3683 + + void + + jakarta.faces.component.html.HtmlInputText.setLabel +
+ ( + String + ) +
+
+ Set the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3684 + + void + + jakarta.faces.component.html.HtmlInputText.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3685 + + void + + jakarta.faces.component.html.HtmlInputText.setMaxlength +
+ ( + int + ) +
+
+ Set the value of the maxlength property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3686 + + void + + jakarta.faces.component.html.HtmlInputText.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3687 + + void + + jakarta.faces.component.html.HtmlInputText.setOnchange +
+ ( + String + ) +
+
+ Set the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3688 + + void + + jakarta.faces.component.html.HtmlInputText.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3689 + + void + + jakarta.faces.component.html.HtmlInputText.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3690 + + void + + jakarta.faces.component.html.HtmlInputText.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3691 + + void + + jakarta.faces.component.html.HtmlInputText.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3692 + + void + + jakarta.faces.component.html.HtmlInputText.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3693 + + void + + jakarta.faces.component.html.HtmlInputText.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3694 + + void + + jakarta.faces.component.html.HtmlInputText.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3695 + + void + + jakarta.faces.component.html.HtmlInputText.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3696 + + void + + jakarta.faces.component.html.HtmlInputText.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3697 + + void + + jakarta.faces.component.html.HtmlInputText.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3698 + + void + + jakarta.faces.component.html.HtmlInputText.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3699 + + void + + jakarta.faces.component.html.HtmlInputText.setOnselect +
+ ( + String + ) +
+
+ Set the value of the onselect property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3700 + + void + + jakarta.faces.component.html.HtmlInputText.setReadonly +
+ ( + boolean + ) +
+
+ Set the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3701 + + void + + jakarta.faces.component.html.HtmlInputText.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3702 + + void + + jakarta.faces.component.html.HtmlInputText.setSize +
+ ( + int + ) +
+
+ Set the value of the size property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3703 + + void + + jakarta.faces.component.html.HtmlInputText.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3704 + + void + + jakarta.faces.component.html.HtmlInputText.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3705 + + void + + jakarta.faces.component.html.HtmlInputText.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3706 + + void + + jakarta.faces.component.html.HtmlInputText.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3707 + + void + + jakarta.faces.component.html.HtmlInputText.setType +
+ ( + String + ) +
+
+ Set the value of the type property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3708 + + String + + jakarta.faces.component.html.HtmlInputText.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3709 + + PropertyKeys + + jakarta.faces.component.html.HtmlInputText.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3710 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlInputText.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3711 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getAccesskey +
+
+
+ Return the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3712 + + int + + jakarta.faces.component.html.HtmlInputTextarea.getCols +
+
+
+ Return the value of the cols property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3713 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3714 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3715 + + Collection + + jakarta.faces.component.html.HtmlInputTextarea.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3716 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getLabel +
+
+
+ Return the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3717 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3718 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getOnblur +
+
+
+ Return the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3719 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getOnchange +
+
+
+ Return the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3720 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3721 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3722 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getOnfocus +
+
+
+ Return the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3723 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3724 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3725 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3726 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3727 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3728 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3729 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3730 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3731 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getOnselect +
+
+
+ Return the value of the onselect property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3732 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3733 + + int + + jakarta.faces.component.html.HtmlInputTextarea.getRows +
+
+
+ Return the value of the rows property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3734 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3735 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3736 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getTabindex +
+
+
+ Return the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3737 + + String + + jakarta.faces.component.html.HtmlInputTextarea.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3738 + + HtmlInputTextarea + + jakarta.faces.component.html.HtmlInputTextarea.HtmlInputTextarea +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3739 + + boolean + + jakarta.faces.component.html.HtmlInputTextarea.isDisabled +
+
+
+ Return the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3740 + + boolean + + jakarta.faces.component.html.HtmlInputTextarea.isReadonly +
+
+
+ Return the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3741 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3742 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setCols +
+ ( + int + ) +
+
+ Set the value of the cols property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3743 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3744 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setDisabled +
+ ( + boolean + ) +
+
+ Set the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3745 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setLabel +
+ ( + String + ) +
+
+ Set the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3746 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3747 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3748 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setOnchange +
+ ( + String + ) +
+
+ Set the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3749 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3750 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3751 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3752 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3753 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3754 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3755 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3756 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3757 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3758 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3759 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3760 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setOnselect +
+ ( + String + ) +
+
+ Set the value of the onselect property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3761 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setReadonly +
+ ( + boolean + ) +
+
+ Set the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3762 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3763 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setRows +
+ ( + int + ) +
+
+ Set the value of the rows property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3764 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3765 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3766 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3767 + + void + + jakarta.faces.component.html.HtmlInputTextarea.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3768 + + String + + jakarta.faces.component.html.HtmlInputTextarea.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3769 + + PropertyKeys + + jakarta.faces.component.html.HtmlInputTextarea.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3770 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlInputTextarea.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3771 + + String + + jakarta.faces.component.html.HtmlMessage.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3772 + + String + + jakarta.faces.component.html.HtmlMessage.getErrorClass +
+
+
+ Return the value of the errorClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3773 + + String + + jakarta.faces.component.html.HtmlMessage.getErrorStyle +
+
+
+ Return the value of the errorStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3774 + + String + + jakarta.faces.component.html.HtmlMessage.getFatalClass +
+
+
+ Return the value of the fatalClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3775 + + String + + jakarta.faces.component.html.HtmlMessage.getFatalStyle +
+
+
+ Return the value of the fatalStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3776 + + String + + jakarta.faces.component.html.HtmlMessage.getInfoClass +
+
+
+ Return the value of the infoClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3777 + + String + + jakarta.faces.component.html.HtmlMessage.getInfoStyle +
+
+
+ Return the value of the infoStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3778 + + String + + jakarta.faces.component.html.HtmlMessage.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3779 + + String + + jakarta.faces.component.html.HtmlMessage.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3780 + + String + + jakarta.faces.component.html.HtmlMessage.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3781 + + String + + jakarta.faces.component.html.HtmlMessage.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3782 + + String + + jakarta.faces.component.html.HtmlMessage.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3783 + + String + + jakarta.faces.component.html.HtmlMessage.getWarnClass +
+
+
+ Return the value of the warnClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3784 + + String + + jakarta.faces.component.html.HtmlMessage.getWarnStyle +
+
+
+ Return the value of the warnStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3785 + + HtmlMessage + + jakarta.faces.component.html.HtmlMessage.HtmlMessage +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3786 + + boolean + + jakarta.faces.component.html.HtmlMessage.isTooltip +
+
+
+ Return the value of the tooltip property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3787 + + void + + jakarta.faces.component.html.HtmlMessage.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3788 + + void + + jakarta.faces.component.html.HtmlMessage.setErrorClass +
+ ( + String + ) +
+
+ Set the value of the errorClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3789 + + void + + jakarta.faces.component.html.HtmlMessage.setErrorStyle +
+ ( + String + ) +
+
+ Set the value of the errorStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3790 + + void + + jakarta.faces.component.html.HtmlMessage.setFatalClass +
+ ( + String + ) +
+
+ Set the value of the fatalClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3791 + + void + + jakarta.faces.component.html.HtmlMessage.setFatalStyle +
+ ( + String + ) +
+
+ Set the value of the fatalStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3792 + + void + + jakarta.faces.component.html.HtmlMessage.setInfoClass +
+ ( + String + ) +
+
+ Set the value of the infoClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3793 + + void + + jakarta.faces.component.html.HtmlMessage.setInfoStyle +
+ ( + String + ) +
+
+ Set the value of the infoStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3794 + + void + + jakarta.faces.component.html.HtmlMessage.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3795 + + void + + jakarta.faces.component.html.HtmlMessage.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3796 + + void + + jakarta.faces.component.html.HtmlMessage.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3797 + + void + + jakarta.faces.component.html.HtmlMessage.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3798 + + void + + jakarta.faces.component.html.HtmlMessage.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3799 + + void + + jakarta.faces.component.html.HtmlMessage.setTooltip +
+ ( + boolean + ) +
+
+ Set the value of the tooltip property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3800 + + void + + jakarta.faces.component.html.HtmlMessage.setWarnClass +
+ ( + String + ) +
+
+ Set the value of the warnClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3801 + + void + + jakarta.faces.component.html.HtmlMessage.setWarnStyle +
+ ( + String + ) +
+
+ Set the value of the warnStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3802 + + String + + jakarta.faces.component.html.HtmlMessage.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3803 + + PropertyKeys + + jakarta.faces.component.html.HtmlMessage.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3804 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlMessage.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3805 + + String + + jakarta.faces.component.html.HtmlMessages.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3806 + + String + + jakarta.faces.component.html.HtmlMessages.getErrorClass +
+
+
+ Return the value of the errorClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3807 + + String + + jakarta.faces.component.html.HtmlMessages.getErrorStyle +
+
+
+ Return the value of the errorStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3808 + + String + + jakarta.faces.component.html.HtmlMessages.getFatalClass +
+
+
+ Return the value of the fatalClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3809 + + String + + jakarta.faces.component.html.HtmlMessages.getFatalStyle +
+
+
+ Return the value of the fatalStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3810 + + String + + jakarta.faces.component.html.HtmlMessages.getInfoClass +
+
+
+ Return the value of the infoClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3811 + + String + + jakarta.faces.component.html.HtmlMessages.getInfoStyle +
+
+
+ Return the value of the infoStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3812 + + String + + jakarta.faces.component.html.HtmlMessages.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3813 + + String + + jakarta.faces.component.html.HtmlMessages.getLayout +
+
+
+ Return the value of the layout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3814 + + String + + jakarta.faces.component.html.HtmlMessages.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3815 + + String + + jakarta.faces.component.html.HtmlMessages.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3816 + + String + + jakarta.faces.component.html.HtmlMessages.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3817 + + String + + jakarta.faces.component.html.HtmlMessages.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3818 + + String + + jakarta.faces.component.html.HtmlMessages.getWarnClass +
+
+
+ Return the value of the warnClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3819 + + String + + jakarta.faces.component.html.HtmlMessages.getWarnStyle +
+
+
+ Return the value of the warnStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3820 + + HtmlMessages + + jakarta.faces.component.html.HtmlMessages.HtmlMessages +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3821 + + boolean + + jakarta.faces.component.html.HtmlMessages.isTooltip +
+
+
+ Return the value of the tooltip property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3822 + + void + + jakarta.faces.component.html.HtmlMessages.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3823 + + void + + jakarta.faces.component.html.HtmlMessages.setErrorClass +
+ ( + String + ) +
+
+ Set the value of the errorClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3824 + + void + + jakarta.faces.component.html.HtmlMessages.setErrorStyle +
+ ( + String + ) +
+
+ Set the value of the errorStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3825 + + void + + jakarta.faces.component.html.HtmlMessages.setFatalClass +
+ ( + String + ) +
+
+ Set the value of the fatalClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3826 + + void + + jakarta.faces.component.html.HtmlMessages.setFatalStyle +
+ ( + String + ) +
+
+ Set the value of the fatalStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3827 + + void + + jakarta.faces.component.html.HtmlMessages.setInfoClass +
+ ( + String + ) +
+
+ Set the value of the infoClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3828 + + void + + jakarta.faces.component.html.HtmlMessages.setInfoStyle +
+ ( + String + ) +
+
+ Set the value of the infoStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3829 + + void + + jakarta.faces.component.html.HtmlMessages.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3830 + + void + + jakarta.faces.component.html.HtmlMessages.setLayout +
+ ( + String + ) +
+
+ Set the value of the layout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3831 + + void + + jakarta.faces.component.html.HtmlMessages.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3832 + + void + + jakarta.faces.component.html.HtmlMessages.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3833 + + void + + jakarta.faces.component.html.HtmlMessages.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3834 + + void + + jakarta.faces.component.html.HtmlMessages.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3835 + + void + + jakarta.faces.component.html.HtmlMessages.setTooltip +
+ ( + boolean + ) +
+
+ Set the value of the tooltip property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3836 + + void + + jakarta.faces.component.html.HtmlMessages.setWarnClass +
+ ( + String + ) +
+
+ Set the value of the warnClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3837 + + void + + jakarta.faces.component.html.HtmlMessages.setWarnStyle +
+ ( + String + ) +
+
+ Set the value of the warnStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3838 + + String + + jakarta.faces.component.html.HtmlMessages.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3839 + + PropertyKeys + + jakarta.faces.component.html.HtmlMessages.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3840 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlMessages.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3841 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getAccesskey +
+
+
+ Return the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3842 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getAlt +
+
+
+ Return the value of the alt property. This attribute is ignored when the image + attribute is not specified. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3843 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3844 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3845 + + Collection + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3846 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getImage +
+
+
+ Return the value of the image property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3847 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3848 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getOnblur +
+
+
+ Return the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3849 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3850 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3851 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getOnfocus +
+
+
+ Return the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3852 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3853 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3854 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3855 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3856 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3857 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3858 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3859 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3860 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3861 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3862 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3863 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getTabindex +
+
+
+ Return the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3864 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3865 + + HtmlOutcomeTargetButton + + jakarta.faces.component.html.HtmlOutcomeTargetButton.HtmlOutcomeTargetButton +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3866 + + boolean + + jakarta.faces.component.html.HtmlOutcomeTargetButton.isDisabled +
+
+
+ Return the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3867 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3868 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setAlt +
+ ( + String + ) +
+
+ Set the value of the alt property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3869 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3870 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setDisabled +
+ ( + boolean + ) +
+
+ Set the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3871 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setImage +
+ ( + String + ) +
+
+ Set the value of the image property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3872 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3873 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3874 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3875 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3876 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3877 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3878 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3879 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3880 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3881 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3882 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3883 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3884 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3885 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3886 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3887 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3888 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3889 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetButton.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3890 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetButton.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3891 + + PropertyKeys + + jakarta.faces.component.html.HtmlOutcomeTargetButton.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3892 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlOutcomeTargetButton.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3893 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getAccesskey +
+
+
+ Return the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3894 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getCharset +
+
+
+ Return the value of the charset property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3895 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getCoords +
+
+
+ Return the value of the coords property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3896 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3897 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3898 + + Collection + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3899 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getHreflang +
+
+
+ Return the value of the hreflang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3900 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3901 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getOnblur +
+
+
+ Return the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3902 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3903 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3904 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getOnfocus +
+
+
+ Return the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3905 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3906 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3907 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3908 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3909 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3910 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3911 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3912 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3913 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getRel +
+
+
+ Return the value of the rel property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3914 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getRev +
+
+
+ Return the value of the rev property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3915 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3916 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getShape +
+
+
+ Return the value of the shape property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3917 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3918 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3919 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getTabindex +
+
+
+ Return the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3920 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getTarget +
+
+
+ Return the value of the target property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3921 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3922 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.getType +
+
+
+ Return the value of the type property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3923 + + HtmlOutcomeTargetLink + + jakarta.faces.component.html.HtmlOutcomeTargetLink.HtmlOutcomeTargetLink +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3924 + + boolean + + jakarta.faces.component.html.HtmlOutcomeTargetLink.isDisabled +
+
+
+ Return the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3925 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3926 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setCharset +
+ ( + String + ) +
+
+ Set the value of the charset property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3927 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setCoords +
+ ( + String + ) +
+
+ Set the value of the coords property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3928 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3929 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setDisabled +
+ ( + boolean + ) +
+
+ Set the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3930 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setHreflang +
+ ( + String + ) +
+
+ Set the value of the hreflang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3931 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3932 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3933 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3934 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3935 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3936 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3937 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3938 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3939 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3940 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3941 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3942 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3943 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3944 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setRel +
+ ( + String + ) +
+
+ Set the value of the rel property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3945 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setRev +
+ ( + String + ) +
+
+ Set the value of the rev property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3946 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3947 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setShape +
+ ( + String + ) +
+
+ Set the value of the shape property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3948 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3949 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3950 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3951 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setTarget +
+ ( + String + ) +
+
+ Set the value of the target property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3952 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3953 + + void + + jakarta.faces.component.html.HtmlOutcomeTargetLink.setType +
+ ( + String + ) +
+
+ Set the value of the type property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3954 + + String + + jakarta.faces.component.html.HtmlOutcomeTargetLink.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3955 + + PropertyKeys + + jakarta.faces.component.html.HtmlOutcomeTargetLink.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3956 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlOutcomeTargetLink.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3957 + + String + + jakarta.faces.component.html.HtmlOutputFormat.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3958 + + String + + jakarta.faces.component.html.HtmlOutputFormat.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3959 + + String + + jakarta.faces.component.html.HtmlOutputFormat.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3960 + + String + + jakarta.faces.component.html.HtmlOutputFormat.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3961 + + String + + jakarta.faces.component.html.HtmlOutputFormat.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3962 + + String + + jakarta.faces.component.html.HtmlOutputFormat.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3963 + + HtmlOutputFormat + + jakarta.faces.component.html.HtmlOutputFormat.HtmlOutputFormat +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3964 + + boolean + + jakarta.faces.component.html.HtmlOutputFormat.isEscape +
+
+
+ Return the value of the escape property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3965 + + void + + jakarta.faces.component.html.HtmlOutputFormat.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3966 + + void + + jakarta.faces.component.html.HtmlOutputFormat.setEscape +
+ ( + boolean + ) +
+
+ Set the value of the escape property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3967 + + void + + jakarta.faces.component.html.HtmlOutputFormat.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3968 + + void + + jakarta.faces.component.html.HtmlOutputFormat.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3969 + + void + + jakarta.faces.component.html.HtmlOutputFormat.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3970 + + void + + jakarta.faces.component.html.HtmlOutputFormat.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3971 + + void + + jakarta.faces.component.html.HtmlOutputFormat.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3972 + + String + + jakarta.faces.component.html.HtmlOutputFormat.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3973 + + PropertyKeys + + jakarta.faces.component.html.HtmlOutputFormat.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3974 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlOutputFormat.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3975 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getAccesskey +
+
+
+ Return the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3976 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3977 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3978 + + Collection + + jakarta.faces.component.html.HtmlOutputLabel.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3979 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getFor +
+
+
+ Return the value of the for property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3980 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3981 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getOnblur +
+
+
+ Return the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3982 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3983 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3984 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getOnfocus +
+
+
+ Return the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3985 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3986 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3987 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3988 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3989 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3990 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3991 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3992 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3993 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3994 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3995 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3996 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getTabindex +
+
+
+ Return the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3997 + + String + + jakarta.faces.component.html.HtmlOutputLabel.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:3998 + + HtmlOutputLabel + + jakarta.faces.component.html.HtmlOutputLabel.HtmlOutputLabel +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:3999 + + boolean + + jakarta.faces.component.html.HtmlOutputLabel.isEscape +
+
+
+ Return the value of the escape property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4000 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4001 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4002 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setEscape +
+ ( + boolean + ) +
+
+ Set the value of the escape property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4003 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setFor +
+ ( + String + ) +
+
+ Set the value of the for property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4004 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4005 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4006 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4007 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4008 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4009 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4010 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4011 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4012 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4013 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4014 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4015 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4016 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4017 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4018 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4019 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4020 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4021 + + void + + jakarta.faces.component.html.HtmlOutputLabel.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4022 + + String + + jakarta.faces.component.html.HtmlOutputLabel.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4023 + + PropertyKeys + + jakarta.faces.component.html.HtmlOutputLabel.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4024 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlOutputLabel.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4025 + + String + + jakarta.faces.component.html.HtmlOutputLink.getAccesskey +
+
+
+ Return the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4026 + + String + + jakarta.faces.component.html.HtmlOutputLink.getCharset +
+
+
+ Return the value of the charset property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4027 + + String + + jakarta.faces.component.html.HtmlOutputLink.getCoords +
+
+
+ Return the value of the coords property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4028 + + String + + jakarta.faces.component.html.HtmlOutputLink.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4029 + + String + + jakarta.faces.component.html.HtmlOutputLink.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4030 + + Collection + + jakarta.faces.component.html.HtmlOutputLink.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4031 + + String + + jakarta.faces.component.html.HtmlOutputLink.getFragment +
+
+
+ Return the value of the fragment property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4032 + + String + + jakarta.faces.component.html.HtmlOutputLink.getHreflang +
+
+
+ Return the value of the hreflang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4033 + + String + + jakarta.faces.component.html.HtmlOutputLink.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4034 + + String + + jakarta.faces.component.html.HtmlOutputLink.getOnblur +
+
+
+ Return the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4035 + + String + + jakarta.faces.component.html.HtmlOutputLink.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4036 + + String + + jakarta.faces.component.html.HtmlOutputLink.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4037 + + String + + jakarta.faces.component.html.HtmlOutputLink.getOnfocus +
+
+
+ Return the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4038 + + String + + jakarta.faces.component.html.HtmlOutputLink.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4039 + + String + + jakarta.faces.component.html.HtmlOutputLink.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4040 + + String + + jakarta.faces.component.html.HtmlOutputLink.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4041 + + String + + jakarta.faces.component.html.HtmlOutputLink.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4042 + + String + + jakarta.faces.component.html.HtmlOutputLink.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4043 + + String + + jakarta.faces.component.html.HtmlOutputLink.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4044 + + String + + jakarta.faces.component.html.HtmlOutputLink.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4045 + + String + + jakarta.faces.component.html.HtmlOutputLink.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4046 + + String + + jakarta.faces.component.html.HtmlOutputLink.getRel +
+
+
+ Return the value of the rel property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4047 + + String + + jakarta.faces.component.html.HtmlOutputLink.getRev +
+
+
+ Return the value of the rev property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4048 + + String + + jakarta.faces.component.html.HtmlOutputLink.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4049 + + String + + jakarta.faces.component.html.HtmlOutputLink.getShape +
+
+
+ Return the value of the shape property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4050 + + String + + jakarta.faces.component.html.HtmlOutputLink.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4051 + + String + + jakarta.faces.component.html.HtmlOutputLink.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4052 + + String + + jakarta.faces.component.html.HtmlOutputLink.getTabindex +
+
+
+ Return the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4053 + + String + + jakarta.faces.component.html.HtmlOutputLink.getTarget +
+
+
+ Return the value of the target property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4054 + + String + + jakarta.faces.component.html.HtmlOutputLink.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4055 + + String + + jakarta.faces.component.html.HtmlOutputLink.getType +
+
+
+ Return the value of the type property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4056 + + HtmlOutputLink + + jakarta.faces.component.html.HtmlOutputLink.HtmlOutputLink +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4057 + + boolean + + jakarta.faces.component.html.HtmlOutputLink.isDisabled +
+
+
+ Return the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4058 + + void + + jakarta.faces.component.html.HtmlOutputLink.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4059 + + void + + jakarta.faces.component.html.HtmlOutputLink.setCharset +
+ ( + String + ) +
+
+ Set the value of the charset property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4060 + + void + + jakarta.faces.component.html.HtmlOutputLink.setCoords +
+ ( + String + ) +
+
+ Set the value of the coords property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4061 + + void + + jakarta.faces.component.html.HtmlOutputLink.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4062 + + void + + jakarta.faces.component.html.HtmlOutputLink.setDisabled +
+ ( + boolean + ) +
+
+ Set the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4063 + + void + + jakarta.faces.component.html.HtmlOutputLink.setFragment +
+ ( + String + ) +
+
+ Set the value of the fragment property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4064 + + void + + jakarta.faces.component.html.HtmlOutputLink.setHreflang +
+ ( + String + ) +
+
+ Set the value of the hreflang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4065 + + void + + jakarta.faces.component.html.HtmlOutputLink.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4066 + + void + + jakarta.faces.component.html.HtmlOutputLink.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4067 + + void + + jakarta.faces.component.html.HtmlOutputLink.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4068 + + void + + jakarta.faces.component.html.HtmlOutputLink.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4069 + + void + + jakarta.faces.component.html.HtmlOutputLink.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4070 + + void + + jakarta.faces.component.html.HtmlOutputLink.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4071 + + void + + jakarta.faces.component.html.HtmlOutputLink.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4072 + + void + + jakarta.faces.component.html.HtmlOutputLink.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4073 + + void + + jakarta.faces.component.html.HtmlOutputLink.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4074 + + void + + jakarta.faces.component.html.HtmlOutputLink.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4075 + + void + + jakarta.faces.component.html.HtmlOutputLink.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4076 + + void + + jakarta.faces.component.html.HtmlOutputLink.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4077 + + void + + jakarta.faces.component.html.HtmlOutputLink.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4078 + + void + + jakarta.faces.component.html.HtmlOutputLink.setRel +
+ ( + String + ) +
+
+ Set the value of the rel property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4079 + + void + + jakarta.faces.component.html.HtmlOutputLink.setRev +
+ ( + String + ) +
+
+ Set the value of the rev property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4080 + + void + + jakarta.faces.component.html.HtmlOutputLink.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4081 + + void + + jakarta.faces.component.html.HtmlOutputLink.setShape +
+ ( + String + ) +
+
+ Set the value of the shape property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4082 + + void + + jakarta.faces.component.html.HtmlOutputLink.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4083 + + void + + jakarta.faces.component.html.HtmlOutputLink.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4084 + + void + + jakarta.faces.component.html.HtmlOutputLink.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4085 + + void + + jakarta.faces.component.html.HtmlOutputLink.setTarget +
+ ( + String + ) +
+
+ Set the value of the target property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4086 + + void + + jakarta.faces.component.html.HtmlOutputLink.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4087 + + void + + jakarta.faces.component.html.HtmlOutputLink.setType +
+ ( + String + ) +
+
+ Set the value of the type property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4088 + + String + + jakarta.faces.component.html.HtmlOutputLink.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4089 + + PropertyKeys + + jakarta.faces.component.html.HtmlOutputLink.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4090 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlOutputLink.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4091 + + String + + jakarta.faces.component.html.HtmlOutputText.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4092 + + String + + jakarta.faces.component.html.HtmlOutputText.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4093 + + String + + jakarta.faces.component.html.HtmlOutputText.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4094 + + String + + jakarta.faces.component.html.HtmlOutputText.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4095 + + String + + jakarta.faces.component.html.HtmlOutputText.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4096 + + String + + jakarta.faces.component.html.HtmlOutputText.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4097 + + HtmlOutputText + + jakarta.faces.component.html.HtmlOutputText.HtmlOutputText +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4098 + + boolean + + jakarta.faces.component.html.HtmlOutputText.isEscape +
+
+
+ Return the value of the escape property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4099 + + void + + jakarta.faces.component.html.HtmlOutputText.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4100 + + void + + jakarta.faces.component.html.HtmlOutputText.setEscape +
+ ( + boolean + ) +
+
+ Set the value of the escape property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4101 + + void + + jakarta.faces.component.html.HtmlOutputText.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4102 + + void + + jakarta.faces.component.html.HtmlOutputText.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4103 + + void + + jakarta.faces.component.html.HtmlOutputText.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4104 + + void + + jakarta.faces.component.html.HtmlOutputText.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4105 + + void + + jakarta.faces.component.html.HtmlOutputText.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4106 + + String + + jakarta.faces.component.html.HtmlOutputText.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4107 + + PropertyKeys + + jakarta.faces.component.html.HtmlOutputText.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4108 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlOutputText.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4109 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getBgcolor +
+
+
+ Return the value of the bgcolor property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4110 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getBodyrows +
+
+
+ Return the value of the bodyrows property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4111 + + int + + jakarta.faces.component.html.HtmlPanelGrid.getBorder +
+
+
+ Return the value of the border property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4112 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getCaptionClass +
+
+
+ Return the value of the captionClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4113 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getCaptionStyle +
+
+
+ Return the value of the captionStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4114 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getCellpadding +
+
+
+ Return the value of the cellpadding property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4115 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getCellspacing +
+
+
+ Return the value of the cellspacing property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4116 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getColumnClasses +
+
+
+ Return the value of the columnClasses property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4117 + + int + + jakarta.faces.component.html.HtmlPanelGrid.getColumns +
+
+
+ Return the value of the columns property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4118 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4119 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4120 + + Collection + + jakarta.faces.component.html.HtmlPanelGrid.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4121 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getFooterClass +
+
+
+ Return the value of the footerClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4122 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getFrame +
+
+
+ Return the value of the frame property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4123 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getHeaderClass +
+
+
+ Return the value of the headerClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4124 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4125 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4126 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4127 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4128 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4129 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4130 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4131 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4132 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4133 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4134 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4135 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4136 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getRowClass +
+
+
+ Return the value of the rowClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4137 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getRowClasses +
+
+
+ Return the value of the rowClasses property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4138 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getRules +
+
+
+ Return the value of the rules property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4139 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4140 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4141 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getSummary +
+
+
+ Return the value of the summary property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4142 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4143 + + String + + jakarta.faces.component.html.HtmlPanelGrid.getWidth +
+
+
+ Return the value of the width property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4144 + + HtmlPanelGrid + + jakarta.faces.component.html.HtmlPanelGrid.HtmlPanelGrid +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4145 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setBgcolor +
+ ( + String + ) +
+
+ Set the value of the bgcolor property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4146 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setBodyrows +
+ ( + String + ) +
+
+ Set the value of the bodyrows property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4147 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setBorder +
+ ( + int + ) +
+
+ Set the value of the border property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4148 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setCaptionClass +
+ ( + String + ) +
+
+ Set the value of the captionClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4149 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setCaptionStyle +
+ ( + String + ) +
+
+ Set the value of the captionStyle property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4150 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setCellpadding +
+ ( + String + ) +
+
+ Set the value of the cellpadding property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4151 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setCellspacing +
+ ( + String + ) +
+
+ Set the value of the cellspacing property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4152 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setColumnClasses +
+ ( + String + ) +
+
+ Set the value of the columnClasses property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4153 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setColumns +
+ ( + int + ) +
+
+ Set the value of the columns property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4154 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4155 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setFooterClass +
+ ( + String + ) +
+
+ Set the value of the footerClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4156 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setFrame +
+ ( + String + ) +
+
+ Set the value of the frame property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4157 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setHeaderClass +
+ ( + String + ) +
+
+ Set the value of the headerClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4158 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4159 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4160 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4161 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4162 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4163 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4164 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4165 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4166 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4167 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4168 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4169 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4170 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setRowClass +
+ ( + String + ) +
+
+ Set the value of the rowClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4171 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setRowClasses +
+ ( + String + ) +
+
+ Set the value of the rowClasses property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4172 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setRules +
+ ( + String + ) +
+
+ Set the value of the rules property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4173 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4174 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4175 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setSummary +
+ ( + String + ) +
+
+ Set the value of the summary property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4176 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4177 + + void + + jakarta.faces.component.html.HtmlPanelGrid.setWidth +
+ ( + String + ) +
+
+ Set the value of the width property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4178 + + String + + jakarta.faces.component.html.HtmlPanelGrid.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4179 + + PropertyKeys + + jakarta.faces.component.html.HtmlPanelGrid.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4180 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlPanelGrid.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4181 + + String + + jakarta.faces.component.html.HtmlPanelGroup.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4182 + + Collection + + jakarta.faces.component.html.HtmlPanelGroup.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4183 + + String + + jakarta.faces.component.html.HtmlPanelGroup.getLayout +
+
+
+ Return the value of the layout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4184 + + String + + jakarta.faces.component.html.HtmlPanelGroup.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4185 + + String + + jakarta.faces.component.html.HtmlPanelGroup.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4186 + + String + + jakarta.faces.component.html.HtmlPanelGroup.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4187 + + String + + jakarta.faces.component.html.HtmlPanelGroup.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4188 + + String + + jakarta.faces.component.html.HtmlPanelGroup.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4189 + + String + + jakarta.faces.component.html.HtmlPanelGroup.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4190 + + String + + jakarta.faces.component.html.HtmlPanelGroup.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4191 + + String + + jakarta.faces.component.html.HtmlPanelGroup.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4192 + + String + + jakarta.faces.component.html.HtmlPanelGroup.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4193 + + String + + jakarta.faces.component.html.HtmlPanelGroup.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4194 + + String + + jakarta.faces.component.html.HtmlPanelGroup.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4195 + + String + + jakarta.faces.component.html.HtmlPanelGroup.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4196 + + HtmlPanelGroup + + jakarta.faces.component.html.HtmlPanelGroup.HtmlPanelGroup +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4197 + + void + + jakarta.faces.component.html.HtmlPanelGroup.setLayout +
+ ( + String + ) +
+
+ Set the value of the layout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4198 + + void + + jakarta.faces.component.html.HtmlPanelGroup.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4199 + + void + + jakarta.faces.component.html.HtmlPanelGroup.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4200 + + void + + jakarta.faces.component.html.HtmlPanelGroup.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4201 + + void + + jakarta.faces.component.html.HtmlPanelGroup.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4202 + + void + + jakarta.faces.component.html.HtmlPanelGroup.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4203 + + void + + jakarta.faces.component.html.HtmlPanelGroup.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4204 + + void + + jakarta.faces.component.html.HtmlPanelGroup.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4205 + + void + + jakarta.faces.component.html.HtmlPanelGroup.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4206 + + void + + jakarta.faces.component.html.HtmlPanelGroup.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4207 + + void + + jakarta.faces.component.html.HtmlPanelGroup.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4208 + + void + + jakarta.faces.component.html.HtmlPanelGroup.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4209 + + void + + jakarta.faces.component.html.HtmlPanelGroup.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4210 + + String + + jakarta.faces.component.html.HtmlPanelGroup.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4211 + + PropertyKeys + + jakarta.faces.component.html.HtmlPanelGroup.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4212 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlPanelGroup.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4213 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getAccesskey +
+
+
+ Return the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4214 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4215 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4216 + + Collection + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4217 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getLabel +
+
+
+ Return the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4218 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4219 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getOnblur +
+
+
+ Return the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4220 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getOnchange +
+
+
+ Return the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4221 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4222 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4223 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getOnfocus +
+
+
+ Return the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4224 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4225 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4226 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4227 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4228 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4229 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4230 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4231 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4232 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getOnselect +
+
+
+ Return the value of the onselect property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4233 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4234 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4235 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4236 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getTabindex +
+
+
+ Return the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4237 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4238 + + HtmlSelectBooleanCheckbox + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.HtmlSelectBooleanCheckbox +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4239 + + boolean + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.isDisabled +
+
+
+ Return the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4240 + + boolean + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.isReadonly +
+
+
+ Return the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4241 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4242 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4243 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setDisabled +
+ ( + boolean + ) +
+
+ Set the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4244 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setLabel +
+ ( + String + ) +
+
+ Set the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4245 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4246 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4247 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setOnchange +
+ ( + String + ) +
+
+ Set the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4248 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4249 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4250 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4251 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4252 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4253 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4254 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4255 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4256 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4257 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4258 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4259 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setOnselect +
+ ( + String + ) +
+
+ Set the value of the onselect property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4260 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setReadonly +
+ ( + boolean + ) +
+
+ Set the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4261 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4262 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4263 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4264 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4265 + + void + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4266 + + String + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4267 + + PropertyKeys + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4268 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlSelectBooleanCheckbox.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4269 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getAccesskey +
+
+
+ Return the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4270 + + int + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getBorder +
+
+
+ Return the value of the border property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4271 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4272 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4273 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getDisabledClass +
+
+
+ Return the value of the disabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4274 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getEnabledClass +
+
+
+ Return the value of the enabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4275 + + Collection + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4276 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getLabel +
+
+
+ Return the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4277 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4278 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getLayout +
+
+
+ Return the value of the layout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4279 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getOnblur +
+
+
+ Return the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4280 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getOnchange +
+
+
+ Return the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4281 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4282 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4283 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getOnfocus +
+
+
+ Return the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4284 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4285 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4286 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4287 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4288 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4289 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4290 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4291 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4292 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getOnselect +
+
+
+ Return the value of the onselect property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4293 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4294 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getSelectedClass +
+
+
+ Return the value of the selectedClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4295 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4296 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4297 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getTabindex +
+
+
+ Return the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4298 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4299 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.getUnselectedClass +
+
+
+ Return the value of the unselectedClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4300 + + HtmlSelectManyCheckbox + + jakarta.faces.component.html.HtmlSelectManyCheckbox.HtmlSelectManyCheckbox +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4301 + + boolean + + jakarta.faces.component.html.HtmlSelectManyCheckbox.isDisabled +
+
+
+ Return the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4302 + + boolean + + jakarta.faces.component.html.HtmlSelectManyCheckbox.isReadonly +
+
+
+ Return the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4303 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4304 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setBorder +
+ ( + int + ) +
+
+ Set the value of the border property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4305 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4306 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setDisabled +
+ ( + boolean + ) +
+
+ Set the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4307 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setDisabledClass +
+ ( + String + ) +
+
+ Set the value of the disabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4308 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setEnabledClass +
+ ( + String + ) +
+
+ Set the value of the enabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4309 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setLabel +
+ ( + String + ) +
+
+ Set the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4310 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4311 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setLayout +
+ ( + String + ) +
+
+ Set the value of the layout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4312 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4313 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setOnchange +
+ ( + String + ) +
+
+ Set the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4314 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4315 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4316 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4317 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4318 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4319 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4320 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4321 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4322 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4323 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4324 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4325 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setOnselect +
+ ( + String + ) +
+
+ Set the value of the onselect property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4326 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setReadonly +
+ ( + boolean + ) +
+
+ Set the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4327 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4328 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setSelectedClass +
+ ( + String + ) +
+
+ Set the value of the selectedClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4329 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4330 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4331 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4332 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4333 + + void + + jakarta.faces.component.html.HtmlSelectManyCheckbox.setUnselectedClass +
+ ( + String + ) +
+
+ Set the value of the unselectedClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4334 + + String + + jakarta.faces.component.html.HtmlSelectManyCheckbox.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4335 + + PropertyKeys + + jakarta.faces.component.html.HtmlSelectManyCheckbox.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4336 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlSelectManyCheckbox.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4337 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getAccesskey +
+
+
+ Return the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4338 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4339 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4340 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getDisabledClass +
+
+
+ Return the value of the disabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4341 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getEnabledClass +
+
+
+ Return the value of the enabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4342 + + Collection + + jakarta.faces.component.html.HtmlSelectManyListbox.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4343 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getLabel +
+
+
+ Return the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4344 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4345 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getOnblur +
+
+
+ Return the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4346 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getOnchange +
+
+
+ Return the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4347 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4348 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4349 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getOnfocus +
+
+
+ Return the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4350 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4351 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4352 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4353 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4354 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4355 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4356 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4357 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4358 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4359 + + int + + jakarta.faces.component.html.HtmlSelectManyListbox.getSize +
+
+
+ Return the value of the size property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4360 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4361 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4362 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getTabindex +
+
+
+ Return the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4363 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4364 + + HtmlSelectManyListbox + + jakarta.faces.component.html.HtmlSelectManyListbox.HtmlSelectManyListbox +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4365 + + boolean + + jakarta.faces.component.html.HtmlSelectManyListbox.isDisabled +
+
+
+ Return the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4366 + + boolean + + jakarta.faces.component.html.HtmlSelectManyListbox.isReadonly +
+
+
+ Return the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4367 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4368 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4369 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setDisabled +
+ ( + boolean + ) +
+
+ Set the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4370 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setDisabledClass +
+ ( + String + ) +
+
+ Set the value of the disabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4371 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setEnabledClass +
+ ( + String + ) +
+
+ Set the value of the enabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4372 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setLabel +
+ ( + String + ) +
+
+ Set the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4373 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4374 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4375 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setOnchange +
+ ( + String + ) +
+
+ Set the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4376 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4377 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4378 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4379 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4380 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4381 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4382 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4383 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4384 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4385 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4386 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4387 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setReadonly +
+ ( + boolean + ) +
+
+ Set the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4388 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4389 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setSize +
+ ( + int + ) +
+
+ Set the value of the size property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4390 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4391 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4392 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4393 + + void + + jakarta.faces.component.html.HtmlSelectManyListbox.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4394 + + String + + jakarta.faces.component.html.HtmlSelectManyListbox.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4395 + + PropertyKeys + + jakarta.faces.component.html.HtmlSelectManyListbox.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4396 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlSelectManyListbox.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4397 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getAccesskey +
+
+
+ Return the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4398 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4399 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4400 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getDisabledClass +
+
+
+ Return the value of the disabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4401 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getEnabledClass +
+
+
+ Return the value of the enabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4402 + + Collection + + jakarta.faces.component.html.HtmlSelectManyMenu.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4403 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getLabel +
+
+
+ Return the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4404 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4405 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getOnblur +
+
+
+ Return the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4406 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getOnchange +
+
+
+ Return the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4407 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4408 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4409 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getOnfocus +
+
+
+ Return the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4410 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4411 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4412 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4413 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4414 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4415 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4416 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4417 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4418 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4419 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4420 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4421 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getTabindex +
+
+
+ Return the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4422 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4423 + + HtmlSelectManyMenu + + jakarta.faces.component.html.HtmlSelectManyMenu.HtmlSelectManyMenu +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4424 + + boolean + + jakarta.faces.component.html.HtmlSelectManyMenu.isDisabled +
+
+
+ Return the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4425 + + boolean + + jakarta.faces.component.html.HtmlSelectManyMenu.isReadonly +
+
+
+ Return the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4426 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4427 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4428 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setDisabled +
+ ( + boolean + ) +
+
+ Set the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4429 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setDisabledClass +
+ ( + String + ) +
+
+ Set the value of the disabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4430 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setEnabledClass +
+ ( + String + ) +
+
+ Set the value of the enabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4431 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setLabel +
+ ( + String + ) +
+
+ Set the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4432 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4433 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4434 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setOnchange +
+ ( + String + ) +
+
+ Set the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4435 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4436 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4437 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4438 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4439 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4440 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4441 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4442 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4443 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4444 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4445 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4446 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setReadonly +
+ ( + boolean + ) +
+
+ Set the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4447 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4448 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4449 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4450 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4451 + + void + + jakarta.faces.component.html.HtmlSelectManyMenu.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4452 + + String + + jakarta.faces.component.html.HtmlSelectManyMenu.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4453 + + PropertyKeys + + jakarta.faces.component.html.HtmlSelectManyMenu.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4454 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlSelectManyMenu.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4455 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getAccesskey +
+
+
+ Return the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4456 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4457 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4458 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getDisabledClass +
+
+
+ Return the value of the disabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4459 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getEnabledClass +
+
+
+ Return the value of the enabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4460 + + Collection + + jakarta.faces.component.html.HtmlSelectOneListbox.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4461 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getLabel +
+
+
+ Return the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4462 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4463 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getOnblur +
+
+
+ Return the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4464 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getOnchange +
+
+
+ Return the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4465 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4466 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4467 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getOnfocus +
+
+
+ Return the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4468 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4469 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4470 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4471 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4472 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4473 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4474 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4475 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4476 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4477 + + int + + jakarta.faces.component.html.HtmlSelectOneListbox.getSize +
+
+
+ Return the value of the size property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4478 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4479 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4480 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getTabindex +
+
+
+ Return the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4481 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4482 + + HtmlSelectOneListbox + + jakarta.faces.component.html.HtmlSelectOneListbox.HtmlSelectOneListbox +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4483 + + boolean + + jakarta.faces.component.html.HtmlSelectOneListbox.isDisabled +
+
+
+ Return the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4484 + + boolean + + jakarta.faces.component.html.HtmlSelectOneListbox.isReadonly +
+
+
+ Return the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4485 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4486 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4487 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setDisabled +
+ ( + boolean + ) +
+
+ Set the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4488 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setDisabledClass +
+ ( + String + ) +
+
+ Set the value of the disabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4489 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setEnabledClass +
+ ( + String + ) +
+
+ Set the value of the enabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4490 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setLabel +
+ ( + String + ) +
+
+ Set the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4491 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4492 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4493 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setOnchange +
+ ( + String + ) +
+
+ Set the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4494 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4495 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4496 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4497 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4498 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4499 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4500 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4501 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4502 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4503 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4504 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4505 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setReadonly +
+ ( + boolean + ) +
+
+ Set the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4506 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4507 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setSize +
+ ( + int + ) +
+
+ Set the value of the size property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4508 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4509 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4510 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4511 + + void + + jakarta.faces.component.html.HtmlSelectOneListbox.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4512 + + String + + jakarta.faces.component.html.HtmlSelectOneListbox.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4513 + + PropertyKeys + + jakarta.faces.component.html.HtmlSelectOneListbox.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4514 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlSelectOneListbox.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4515 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getAccesskey +
+
+
+ Return the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4516 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4517 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4518 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getDisabledClass +
+
+
+ Return the value of the disabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4519 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getEnabledClass +
+
+
+ Return the value of the enabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4520 + + Collection + + jakarta.faces.component.html.HtmlSelectOneMenu.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4521 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getLabel +
+
+
+ Return the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4522 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4523 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getOnblur +
+
+
+ Return the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4524 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getOnchange +
+
+
+ Return the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4525 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4526 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4527 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getOnfocus +
+
+
+ Return the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4528 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4529 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4530 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4531 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4532 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4533 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4534 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4535 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4536 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4537 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4538 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4539 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getTabindex +
+
+
+ Return the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4540 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4541 + + HtmlSelectOneMenu + + jakarta.faces.component.html.HtmlSelectOneMenu.HtmlSelectOneMenu +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4542 + + boolean + + jakarta.faces.component.html.HtmlSelectOneMenu.isDisabled +
+
+
+ Return the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4543 + + boolean + + jakarta.faces.component.html.HtmlSelectOneMenu.isReadonly +
+
+
+ Return the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4544 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4545 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4546 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setDisabled +
+ ( + boolean + ) +
+
+ Set the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4547 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setDisabledClass +
+ ( + String + ) +
+
+ Set the value of the disabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4548 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setEnabledClass +
+ ( + String + ) +
+
+ Set the value of the enabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4549 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setLabel +
+ ( + String + ) +
+
+ Set the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4550 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4551 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4552 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setOnchange +
+ ( + String + ) +
+
+ Set the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4553 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4554 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4555 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4556 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4557 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4558 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4559 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4560 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4561 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4562 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4563 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4564 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setReadonly +
+ ( + boolean + ) +
+
+ Set the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4565 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4566 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4567 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4568 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4569 + + void + + jakarta.faces.component.html.HtmlSelectOneMenu.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4570 + + String + + jakarta.faces.component.html.HtmlSelectOneMenu.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4571 + + PropertyKeys + + jakarta.faces.component.html.HtmlSelectOneMenu.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4572 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlSelectOneMenu.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4573 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getAccesskey +
+
+
+ Return the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4574 + + int + + jakarta.faces.component.html.HtmlSelectOneRadio.getBorder +
+
+
+ Return the value of the border property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4575 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getDefaultEventName +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not + implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation + of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4576 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getDir +
+
+
+ Return the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4577 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getDisabledClass +
+
+
+ Return the value of the disabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4578 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getEnabledClass +
+
+
+ Return the value of the enabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4579 + + Collection + + jakarta.faces.component.html.HtmlSelectOneRadio.getEventNames +
+
+
+ This is a default implementation of + jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement + the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default + implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to + simplify subclass implementations. Subclasses that wish to support the + jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass + implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to + return a non-Empty Collection of the client event names that the component supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4580 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getGroup +
+
+
+ Return the value of the group property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4581 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getLabel +
+
+
+ Return the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4582 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getLang +
+
+
+ Return the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4583 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getLayout +
+
+
+ Return the value of the layout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4584 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getOnblur +
+
+
+ Return the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4585 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getOnchange +
+
+
+ Return the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4586 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getOnclick +
+
+
+ Return the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4587 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getOndblclick +
+
+
+ Return the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4588 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getOnfocus +
+
+
+ Return the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4589 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getOnkeydown +
+
+
+ Return the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4590 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getOnkeypress +
+
+
+ Return the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4591 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getOnkeyup +
+
+
+ Return the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4592 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getOnmousedown +
+
+
+ Return the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4593 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getOnmousemove +
+
+
+ Return the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4594 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getOnmouseout +
+
+
+ Return the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4595 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getOnmouseover +
+
+
+ Return the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4596 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getOnmouseup +
+
+
+ Return the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4597 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getOnselect +
+
+
+ Return the value of the onselect property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4598 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getRole +
+
+
+ Return the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4599 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getStyle +
+
+
+ Return the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4600 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getStyleClass +
+
+
+ Return the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4601 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getTabindex +
+
+
+ Return the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4602 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.getTitle +
+
+
+ Return the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4603 + + HtmlSelectOneRadio + + jakarta.faces.component.html.HtmlSelectOneRadio.HtmlSelectOneRadio +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4604 + + boolean + + jakarta.faces.component.html.HtmlSelectOneRadio.isDisabled +
+
+
+ Return the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4605 + + boolean + + jakarta.faces.component.html.HtmlSelectOneRadio.isReadonly +
+
+
+ Return the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4606 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setAccesskey +
+ ( + String + ) +
+
+ Set the value of the accesskey property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4607 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setBorder +
+ ( + int + ) +
+
+ Set the value of the border property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4608 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setDir +
+ ( + String + ) +
+
+ Set the value of the dir property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4609 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setDisabled +
+ ( + boolean + ) +
+
+ Set the value of the disabled property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4610 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setDisabledClass +
+ ( + String + ) +
+
+ Set the value of the disabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4611 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setEnabledClass +
+ ( + String + ) +
+
+ Set the value of the enabledClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4612 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setGroup +
+ ( + String + ) +
+
+ Set the value of the group property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4613 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setLabel +
+ ( + String + ) +
+
+ Set the value of the label property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4614 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setLang +
+ ( + String + ) +
+
+ Set the value of the lang property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4615 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setLayout +
+ ( + String + ) +
+
+ Set the value of the layout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4616 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setOnblur +
+ ( + String + ) +
+
+ Set the value of the onblur property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4617 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setOnchange +
+ ( + String + ) +
+
+ Set the value of the onchange property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4618 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setOnclick +
+ ( + String + ) +
+
+ Set the value of the onclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4619 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setOndblclick +
+ ( + String + ) +
+
+ Set the value of the ondblclick property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4620 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setOnfocus +
+ ( + String + ) +
+
+ Set the value of the onfocus property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4621 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setOnkeydown +
+ ( + String + ) +
+
+ Set the value of the onkeydown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4622 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setOnkeypress +
+ ( + String + ) +
+
+ Set the value of the onkeypress property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4623 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setOnkeyup +
+ ( + String + ) +
+
+ Set the value of the onkeyup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4624 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setOnmousedown +
+ ( + String + ) +
+
+ Set the value of the onmousedown property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4625 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setOnmousemove +
+ ( + String + ) +
+
+ Set the value of the onmousemove property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4626 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setOnmouseout +
+ ( + String + ) +
+
+ Set the value of the onmouseout property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4627 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setOnmouseover +
+ ( + String + ) +
+
+ Set the value of the onmouseover property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4628 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setOnmouseup +
+ ( + String + ) +
+
+ Set the value of the onmouseup property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4629 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setOnselect +
+ ( + String + ) +
+
+ Set the value of the onselect property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4630 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setReadonly +
+ ( + boolean + ) +
+
+ Set the value of the readonly property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4631 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setRole +
+ ( + String + ) +
+
+ Set the value of the role property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4632 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setStyle +
+ ( + String + ) +
+
+ Set the value of the style property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4633 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setStyleClass +
+ ( + String + ) +
+
+ Set the value of the styleClass property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4634 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setTabindex +
+ ( + String + ) +
+
+ Set the value of the tabindex property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4635 + + void + + jakarta.faces.component.html.HtmlSelectOneRadio.setTitle +
+ ( + String + ) +
+
+ Set the value of the title property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4636 + + String + + jakarta.faces.component.html.HtmlSelectOneRadio.PropertyKeys.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4637 + + PropertyKeys + + jakarta.faces.component.html.HtmlSelectOneRadio.PropertyKeys.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4638 + + PropertyKeys[] + + jakarta.faces.component.html.HtmlSelectOneRadio.PropertyKeys.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4639 + + ComponentNotFoundException + + jakarta.faces.component.search.ComponentNotFoundException.ComponentNotFoundException +
+
+
+ Construct a new exception with no detail message or root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4640 + + ComponentNotFoundException + + jakarta.faces.component.search.ComponentNotFoundException.ComponentNotFoundException +
+ ( + String + ) +
+
+ Construct a new exception with the specified detail message and no root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4641 + + ComponentNotFoundException + + jakarta.faces.component.search.ComponentNotFoundException.ComponentNotFoundException +
+ ( + Throwable + ) +
+
+ Construct a new exception with the specified root cause. The detail message will be set + to (cause == null ? null : cause.toString() + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4642 + + ComponentNotFoundException + + jakarta.faces.component.search.ComponentNotFoundException.ComponentNotFoundException +
+ ( + String + , +
+ Throwable + ) +
+
+ Construct a new exception with the specified detail message and root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4643 + + SearchExpressionContext + + jakarta.faces.component.search.SearchExpressionContext.createSearchExpressionContext +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Creates a SearchExpressionContext instance for use with the SearchExpressionHandler. + This method can be used to obtain a SearchExpressionContext instance without any VisitHint or + SearchExpressionHint. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4644 + + SearchExpressionContext + + jakarta.faces.component.search.SearchExpressionContext.createSearchExpressionContext +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Set + , +
+ Set + ) +
+
+ Creates a SearchExpressionContext instance for use with the SearchExpressionHandler. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4645 + + Set + + jakarta.faces.component.search.SearchExpressionContext.getExpressionHints +
+
+
+ Returns hints that influence the behavior of resolving the expression. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4646 + + FacesContext + + jakarta.faces.component.search.SearchExpressionContext.getFacesContext +
+
+
+ Returns the FacesContext for the current request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4647 + + UIComponent + + jakarta.faces.component.search.SearchExpressionContext.getSource +
+
+
+ Returns the source / base component from which we will start to perform our search. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4648 + + Set + + jakarta.faces.component.search.SearchExpressionContext.getVisitHints +
+
+
+ Returns hints that influence the behavior of the tree visit, if it's used by an + SearchKeywordResolver implementation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4649 + + SearchExpressionContext + + jakarta.faces.component.search.SearchExpressionContext.SearchExpressionContext +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4650 + + SearchExpressionContext + + + jakarta.faces.component.search.SearchExpressionContextFactory.getSearchExpressionContext +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Set + , +
+ Set + ) +
+
+ Creates a SearchExpressionContext instance for use with the SearchExpressionHandler. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4651 + + SearchExpressionContextFactory + + jakarta.faces.component.search.SearchExpressionContextFactory.getWrapped +
+
+
+ If this factory has been decorated, the implementation doing the decorating may + override this method to provide access to the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4652 + + SearchExpressionContextFactory + + + jakarta.faces.component.search.SearchExpressionContextFactory.SearchExpressionContextFactory +
+ ( + SearchExpressionContextFactory + ) +
+
+ If this factory has been decorated, the implementation doing the decorating should push + the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4653 + + char[] + + jakarta.faces.component.search.SearchExpressionHandler.getExpressionSeperatorChars +
+ ( + FacesContext + ) +
+
+ Return the characters used to separate expressions in a series of expressions. The + default implementation returns SearchExpressionHandler#EXPRESSION_SEPARATOR_CHARS. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4654 + + void + + jakarta.faces.component.search.SearchExpressionHandler.invokeOnComponent +
+ ( + SearchExpressionContext + , +
+ String + , +
+ ContextCallback + ) +
+
+ Resolves multiple UIComponents for the given expression. For each resolved component, + the ContextCallback will be invoked. This method is the most essential method in the API. It + implements the algorithm which handles the recursion of the keywords and id's. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4655 + + void + + jakarta.faces.component.search.SearchExpressionHandler.invokeOnComponent +
+ ( + SearchExpressionContext + , +
+ UIComponent + , +
+ String + , +
+ ContextCallback + ) +
+
+ Resolves multiple UIComponents for the given expression. For each resolved component, + the ContextCallback will be invoked. This method is the most essential method in the API. It + implements the algorithm which handles the recursion of the keywords and id's. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4656 + + boolean + + jakarta.faces.component.search.SearchExpressionHandler.isPassthroughExpression +
+ ( + SearchExpressionContext + , +
+ String + ) +
+
+ Checks if the given expression is a "passtrough expression". A passthrough expression + must only be a keyword. This keyword will not be resolved by the SearchKeywordResolver and will be + returned untouched. The client is responsible to resolve it later. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4657 + + boolean + + jakarta.faces.component.search.SearchExpressionHandler.isValidExpression +
+ ( + SearchExpressionContext + , +
+ String + ) +
+
+ Checks if the given expression is a valid expression. A expression is invalid if: No + SearchKeywordResolver matches the requested keyword A keyword or id is placed after a leaf keyword + (@none:@form) + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4658 + + String + + jakarta.faces.component.search.SearchExpressionHandler.resolveClientId +
+ ( + SearchExpressionContext + , +
+ String + ) +
+
+ Resolves to a single clientId or passthrough expression for the given expression. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4659 + + List + + jakarta.faces.component.search.SearchExpressionHandler.resolveClientIds +
+ ( + SearchExpressionContext + , +
+ String + ) +
+
+ Resolves to a List with clientIds or passthrough expressions for the given expressions. + The expressions will be splitted by #splitExpressions(jakarta.faces.context.FacesContext, + java.lang.String) and resolved one by one. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4660 + + void + + jakarta.faces.component.search.SearchExpressionHandler.resolveComponent +
+ ( + SearchExpressionContext + , +
+ String + , +
+ ContextCallback + ) +
+
+ Resolves a single UIComponents for the given expression. If the component is resolved, + the ContextCallback will be invoked. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4661 + + void + + jakarta.faces.component.search.SearchExpressionHandler.resolveComponents +
+ ( + SearchExpressionContext + , +
+ String + , +
+ ContextCallback + ) +
+
+ Resolves multiple UIComponents for the given expression(s). The expressions will be + splitted by #splitExpressions(jakarta.faces.context.FacesContext, java.lang.String) and resolved one + by one. For each resolved component, the ContextCallback will be invoked. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4662 + + SearchExpressionHandler + + jakarta.faces.component.search.SearchExpressionHandler.SearchExpressionHandler +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4663 + + String[] + + jakarta.faces.component.search.SearchExpressionHandler.splitExpressions +
+ ( + FacesContext + , +
+ String + ) +
+
+ Splits an string, based on + #getExpressionSeperatorChars(jakarta.faces.context.FacesContext) with possible multiple expressions + into an array. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4664 + + char[] + + + jakarta.faces.component.search.SearchExpressionHandlerWrapper.getExpressionSeperatorChars +
+ ( + FacesContext + ) +
+
+ Return the characters used to separate expressions in a series of expressions. The + default implementation returns SearchExpressionHandler#EXPRESSION_SEPARATOR_CHARS. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4665 + + SearchExpressionHandler + + jakarta.faces.component.search.SearchExpressionHandlerWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4666 + + void + + jakarta.faces.component.search.SearchExpressionHandlerWrapper.invokeOnComponent +
+ ( + SearchExpressionContext + , +
+ String + , +
+ ContextCallback + ) +
+
+ Resolves multiple UIComponents for the given expression. For each resolved component, + the ContextCallback will be invoked. This method is the most essential method in the API. It + implements the algorithm which handles the recursion of the keywords and id's. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4667 + + void + + jakarta.faces.component.search.SearchExpressionHandlerWrapper.invokeOnComponent +
+ ( + SearchExpressionContext + , +
+ UIComponent + , +
+ String + , +
+ ContextCallback + ) +
+
+ Resolves multiple UIComponents for the given expression. For each resolved component, + the ContextCallback will be invoked. This method is the most essential method in the API. It + implements the algorithm which handles the recursion of the keywords and id's. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4668 + + boolean + + jakarta.faces.component.search.SearchExpressionHandlerWrapper.isPassthroughExpression +
+ ( + SearchExpressionContext + , +
+ String + ) +
+
+ Checks if the given expression is a "passtrough expression". A passthrough expression + must only be a keyword. This keyword will not be resolved by the SearchKeywordResolver and will be + returned untouched. The client is responsible to resolve it later. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4669 + + boolean + + jakarta.faces.component.search.SearchExpressionHandlerWrapper.isValidExpression +
+ ( + SearchExpressionContext + , +
+ String + ) +
+
+ Checks if the given expression is a valid expression. A expression is invalid if: No + SearchKeywordResolver matches the requested keyword A keyword or id is placed after a leaf keyword + (@none:@form) + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4670 + + String + + jakarta.faces.component.search.SearchExpressionHandlerWrapper.resolveClientId +
+ ( + SearchExpressionContext + , +
+ String + ) +
+
+ Resolves to a single clientId or passthrough expression for the given expression. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4671 + + List + + jakarta.faces.component.search.SearchExpressionHandlerWrapper.resolveClientIds +
+ ( + SearchExpressionContext + , +
+ String + ) +
+
+ Resolves to a List with clientIds or passthrough expressions for the given expressions. + The expressions will be splitted by #splitExpressions(jakarta.faces.context.FacesContext, + java.lang.String) and resolved one by one. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4672 + + void + + jakarta.faces.component.search.SearchExpressionHandlerWrapper.resolveComponent +
+ ( + SearchExpressionContext + , +
+ String + , +
+ ContextCallback + ) +
+
+ Resolves a single UIComponents for the given expression. If the component is resolved, + the ContextCallback will be invoked. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4673 + + void + + jakarta.faces.component.search.SearchExpressionHandlerWrapper.resolveComponents +
+ ( + SearchExpressionContext + , +
+ String + , +
+ ContextCallback + ) +
+
+ Resolves multiple UIComponents for the given expression(s). The expressions will be + splitted by #splitExpressions(jakarta.faces.context.FacesContext, java.lang.String) and resolved one + by one. For each resolved component, the ContextCallback will be invoked. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4674 + + SearchExpressionHandlerWrapper + + + jakarta.faces.component.search.SearchExpressionHandlerWrapper.SearchExpressionHandlerWrapper +
+ ( + SearchExpressionHandler + ) +
+
+ If this search expression handler has been decorated, the implementation doing the + decorating should push the implementation being wrapped to this constructor. The #getWrapped() will + then return the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4675 + + String[] + + jakarta.faces.component.search.SearchExpressionHandlerWrapper.splitExpressions +
+ ( + FacesContext + , +
+ String + ) +
+
+ Splits an string, based on + #getExpressionSeperatorChars(jakarta.faces.context.FacesContext) with possible multiple expressions + into an array. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4676 + + SearchExpressionHint + + jakarta.faces.component.search.SearchExpressionHint.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4677 + + SearchExpressionHint[] + + jakarta.faces.component.search.SearchExpressionHint.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4678 + + ContextCallback + + jakarta.faces.component.search.SearchKeywordContext.getCallback +
+
+
+ Returns the ContextCallback for the current request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4679 + + String + + jakarta.faces.component.search.SearchKeywordContext.getRemainingExpression +
+
+
+ Returns the remaining expression for the current request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4680 + + SearchExpressionContext + + jakarta.faces.component.search.SearchKeywordContext.getSearchExpressionContext +
+
+
+ Returns the SearchExpressionContext for the current request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4681 + + void + + jakarta.faces.component.search.SearchKeywordContext.invokeContextCallback +
+ ( + UIComponent + ) +
+
+ This method will be called by an implementation of SearchKeywordResolver#resolve with + the resolved component for the keyword. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4682 + + boolean + + jakarta.faces.component.search.SearchKeywordContext.isKeywordResolved +
+
+
+ Returns if the keyword was resolved. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4683 + + SearchKeywordContext + + jakarta.faces.component.search.SearchKeywordContext.SearchKeywordContext +
+ ( + SearchExpressionContext + , +
+ ContextCallback + , +
+ String + ) +
+
+ Construct a new context with the given arguments. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4684 + + void + + jakarta.faces.component.search.SearchKeywordContext.setKeywordResolved +
+ ( + boolean + ) +
+
+ Sets if the keyword was resolved. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4685 + + boolean + + jakarta.faces.component.search.SearchKeywordResolver.isLeaf +
+ ( + SearchExpressionContext + , +
+ String + ) +
+
+ A leaf keyword is a keyword that does not allow to be combined with keywords or id + chains to the right. For example: @none:@parent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4686 + + boolean + + jakarta.faces.component.search.SearchKeywordResolver.isPassthrough +
+ ( + SearchExpressionContext + , +
+ String + ) +
+
+ A passthrough keyword is a keyword, that according to the context, does not require to + be resolved on the server, and can be passed "unresolved" to the client. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4687 + + boolean + + jakarta.faces.component.search.SearchKeywordResolver.isResolverForKeyword +
+ ( + SearchExpressionContext + , +
+ String + ) +
+
+ Checks if the current instance of the SearchKeywordResolver is responsible for + resolving the keyword. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4688 + + void + + jakarta.faces.component.search.SearchKeywordResolver.resolve +
+ ( + SearchKeywordContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Try to resolve one or multiple UIComponents based on the keyword and calls + SearchKeywordContext#invokeContextCallback(jakarta.faces.component.UIComponent) for each resolved + component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4689 + + SearchKeywordResolver + + jakarta.faces.component.search.SearchKeywordResolver.SearchKeywordResolver +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4690 + + VisitResult + + jakarta.faces.component.visit.VisitCallback.visit +
+ ( + VisitContext + , +
+ UIComponent + ) +
+
+ This method is called during component tree visits by VisitContext#invokeVisitCallback + VisitContext.invokeVisitCallback() to visit the specified component. At the point in time when this + method is called, the argument target is guaranteed to be in the proper state with respect to its + ancestors in the View. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4691 + + VisitContext + + jakarta.faces.component.visit.VisitContext.createVisitContext +
+ ( + FacesContext + , +
+ Collection + , +
+ Set + ) +
+
+ Returns a VisitContext instance that is initialized with the specified ids and hintsfor + use with UIComponent#visitTree. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4692 + + VisitContext + + jakarta.faces.component.visit.VisitContext.createVisitContext +
+ ( + FacesContext + ) +
+
+ Creates a VisitContext instance for use with UIComponent#visitTree + UIComponent.visitTree(). This method can be used to obtain a VisitContext instance when all + components should be visited with the default visit hints. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4693 + + FacesContext + + jakarta.faces.component.visit.VisitContext.getFacesContext +
+
+
+ Returns the FacesContext for the current request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4694 + + Set + + jakarta.faces.component.visit.VisitContext.getHints +
+
+
+ Returns hints that influence the behavior of the tree visit. Interested parties, such + as UIComponent#visitTree UIComponent.visitTree() implementations, may check to see whether a + particular hint is present by calling VisitContext.getHints().contains(), passing in one of the + hints defined by VisitHint. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4695 + + Collection + + jakarta.faces.component.visit.VisitContext.getIdsToVisit +
+
+
+ Returns the ids of the components to visit. In the case of a full tree visit, this + method returns the ALL_IDS collection. Otherwise, if a partial visit is beign performed, returns a + modifiable collection containing the client ids of the components that should be visited. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4696 + + Collection + + jakarta.faces.component.visit.VisitContext.getSubtreeIdsToVisit +
+ ( + UIComponent + ) +
+
+ Given a jakarta.faces.component.NamingContainer component, returns the client ids of + any components underneath the NamingContainer that should be visited. This method is called by + NamingContainer visitTree() implementations to determine whether the NamingContainer contains + components to be visited. In the case where no such components exist, the NamingContainer can + short-circuit the tree visit and avoid descending into child subtrees. In addition, iterating + components such as UIData may be able to use the returned ids to determine which iterated states + (ie. rows) need to be visited. This allows the visit traversal to be contstrained such only those + rows that contain visit targets need to be traversed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4697 + + VisitResult + + jakarta.faces.component.visit.VisitContext.invokeVisitCallback +
+ ( + UIComponent + , +
+ VisitCallback + ) +
+
+ Called by UIComponent#visitTree UIComponent.visitTree() to visit a single component. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4698 + + VisitContext + + jakarta.faces.component.visit.VisitContext.VisitContext +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4699 + + VisitContext + + jakarta.faces.component.visit.VisitContextFactory.getVisitContext +
+ ( + FacesContext + , +
+ Collection + , +
+ Set + ) +
+
+ Return a new VisitContext instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4700 + + VisitContextFactory + + jakarta.faces.component.visit.VisitContextFactory.getWrapped +
+
+
+ If this factory has been decorated, the implementation doing the decorating may + override this method to provide access to the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4701 + + VisitContextFactory + + jakarta.faces.component.visit.VisitContextFactory.VisitContextFactory +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:4702 + + VisitContextFactory + + jakarta.faces.component.visit.VisitContextFactory.VisitContextFactory +
+ ( + VisitContextFactory + ) +
+
+ If this factory has been decorated, the implementation doing the decorating should push + the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4703 + + FacesContext + + jakarta.faces.component.visit.VisitContextWrapper.getFacesContext +
+
+
+ Returns the FacesContext for the current request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4704 + + Set + + jakarta.faces.component.visit.VisitContextWrapper.getHints +
+
+
+ Returns hints that influence the behavior of the tree visit. Interested parties, such + as UIComponent#visitTree UIComponent.visitTree() implementations, may check to see whether a + particular hint is present by calling VisitContext.getHints().contains(), passing in one of the + hints defined by VisitHint. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4705 + + Collection + + jakarta.faces.component.visit.VisitContextWrapper.getIdsToVisit +
+
+
+ Returns the ids of the components to visit. In the case of a full tree visit, this + method returns the ALL_IDS collection. Otherwise, if a partial visit is beign performed, returns a + modifiable collection containing the client ids of the components that should be visited. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4706 + + Collection + + jakarta.faces.component.visit.VisitContextWrapper.getSubtreeIdsToVisit +
+ ( + UIComponent + ) +
+
+ Given a jakarta.faces.component.NamingContainer component, returns the client ids of + any components underneath the NamingContainer that should be visited. This method is called by + NamingContainer visitTree() implementations to determine whether the NamingContainer contains + components to be visited. In the case where no such components exist, the NamingContainer can + short-circuit the tree visit and avoid descending into child subtrees. In addition, iterating + components such as UIData may be able to use the returned ids to determine which iterated states + (ie. rows) need to be visited. This allows the visit traversal to be contstrained such only those + rows that contain visit targets need to be traversed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4707 + + VisitContext + + jakarta.faces.component.visit.VisitContextWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4708 + + VisitResult + + jakarta.faces.component.visit.VisitContextWrapper.invokeVisitCallback +
+ ( + UIComponent + , +
+ VisitCallback + ) +
+
+ Called by UIComponent#visitTree UIComponent.visitTree() to visit a single component. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4709 + + VisitContextWrapper + + jakarta.faces.component.visit.VisitContextWrapper.VisitContextWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:4710 + + VisitContextWrapper + + jakarta.faces.component.visit.VisitContextWrapper.VisitContextWrapper +
+ ( + VisitContext + ) +
+
+ If this visit context has been decorated, the implementation doing the decorating + should push the implementation being wrapped to this constructor. The #getWrapped() will then return + the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4711 + + VisitHint + + jakarta.faces.component.visit.VisitHint.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4712 + + VisitHint[] + + jakarta.faces.component.visit.VisitHint.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4713 + + VisitResult + + jakarta.faces.component.visit.VisitResult.valueOf +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4714 + + VisitResult[] + + jakarta.faces.component.visit.VisitResult.values +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4715 + + ExceptionHandler + + jakarta.faces.context.ExceptionHandler.ExceptionHandler +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4716 + + ExceptionQueuedEvent + + jakarta.faces.context.ExceptionHandler.getHandledExceptionQueuedEvent +
+
+
+ Return the first ExceptionQueuedEvent handled by this handler. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4717 + + Iterable + + jakarta.faces.context.ExceptionHandler.getHandledExceptionQueuedEvents +
+
+
+ The default implementation must return an Iterable over all ExceptionQueuedEvents that + have been handled by the #handle method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4718 + + Throwable + + jakarta.faces.context.ExceptionHandler.getRootCause +
+ ( + Throwable + ) +
+
+ Unwrap the argument t until the unwrapping encounters an Object whose getClass() is not + equal to FacesException.class or jakarta.el.ELException.class. If there is no root cause, null is + returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4719 + + Iterable + + jakarta.faces.context.ExceptionHandler.getUnhandledExceptionQueuedEvents +
+
+
+ Return an Iterable over all ExceptionQueuedEvents that have not yet been handled by the + #handle method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4720 + + void + + jakarta.faces.context.ExceptionHandler.handle +
+
+
+ Take action to handle the Exception instances residing inside the ExceptionQueuedEvent + instances that have been queued by calls to Application().publishEvent(ExceptionQueuedEvent.class, + eventContext). The requirements of the default implementation are detailed in section 6.2.1 "Default + ExceptionHandler implementation" of the Jakarta Faces Specification Document. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4721 + + void + + jakarta.faces.context.ExceptionHandler.handle +
+
+ throws + FacesException +
+
+
+ if and only if a problem occurs while performing the algorithm to handle the Exception, + not as a means of conveying a handled Exception itself. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4722 + + boolean + + jakarta.faces.context.ExceptionHandler.isListenerForSource +
+ ( + Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4723 + + void + + jakarta.faces.context.ExceptionHandler.processEvent +
+ ( + SystemEvent + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4724 + + void + + jakarta.faces.context.ExceptionHandler.processEvent +
+ ( + SystemEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4725 + + ExceptionHandlerFactory + + jakarta.faces.context.ExceptionHandlerFactory.ExceptionHandlerFactory +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:4726 + + ExceptionHandlerFactory + + jakarta.faces.context.ExceptionHandlerFactory.ExceptionHandlerFactory +
+ ( + ExceptionHandlerFactory + ) +
+
+ If this factory has been decorated, the implementation doing the decorating should push + the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4727 + + ExceptionHandler + + jakarta.faces.context.ExceptionHandlerFactory.getExceptionHandler +
+
+
+ Create and return a A new ExceptionHandler instance. The implementation must return an + ExceptionHandler instance suitable for the environment. For example, in some cases it may be + desirable for an ExceptionHandler to write error information to the response instead of throwing + exceptions as in the case of Ajax applications. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4728 + + ExceptionHandlerFactory + + jakarta.faces.context.ExceptionHandlerFactory.getWrapped +
+
+
+ If this factory has been decorated, the implementation doing the decorating may + override this method to provide access to the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4729 + + ExceptionHandlerWrapper + + jakarta.faces.context.ExceptionHandlerWrapper.ExceptionHandlerWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:4730 + + ExceptionHandlerWrapper + + jakarta.faces.context.ExceptionHandlerWrapper.ExceptionHandlerWrapper +
+ ( + ExceptionHandler + ) +
+
+ If this exception handler has been decorated, the implementation doing the decorating + should push the implementation being wrapped to this constructor. The #getWrapped() will then return + the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4731 + + ExceptionQueuedEvent + + jakarta.faces.context.ExceptionHandlerWrapper.getHandledExceptionQueuedEvent +
+
+
+ The default behavior of this method is to call + ExceptionHandler#getHandledExceptionQueuedEvent() on the wrapped ExceptionHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4732 + + Iterable + + jakarta.faces.context.ExceptionHandlerWrapper.getHandledExceptionQueuedEvents +
+
+
+ The default behavior of this method is to call + ExceptionHandler#getHandledExceptionQueuedEvents() on the wrapped ExceptionHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4733 + + Throwable + + jakarta.faces.context.ExceptionHandlerWrapper.getRootCause +
+ ( + Throwable + ) +
+
+ The default behavior of this method is to call + jakarta.faces.context.ExceptionHandler#getRootCause(Throwable) on the wrapped ExceptionHandler + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4734 + + Iterable + + jakarta.faces.context.ExceptionHandlerWrapper.getUnhandledExceptionQueuedEvents +
+
+
+ The default behavior of this method is to call + ExceptionHandler#getUnhandledExceptionQueuedEvents() on the wrapped ExceptionHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4735 + + ExceptionHandler + + jakarta.faces.context.ExceptionHandlerWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4736 + + void + + jakarta.faces.context.ExceptionHandlerWrapper.handle +
+
+
+ The default behavior of this method is to call + jakarta.faces.context.ExceptionHandler#handle() on the wrapped ExceptionHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4737 + + void + + jakarta.faces.context.ExceptionHandlerWrapper.handle +
+
+ throws + FacesException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4738 + + boolean + + jakarta.faces.context.ExceptionHandlerWrapper.isListenerForSource +
+ ( + Object + ) +
+
+ The default behavior of this method is to call + jakarta.faces.context.ExceptionHandler#isListenerForSource(Object) on the wrapped ExceptionHandler + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4739 + + void + + jakarta.faces.context.ExceptionHandlerWrapper.processEvent +
+ ( + SystemEvent + ) +
+
+ The default behavior of this method is to call + jakarta.faces.context.ExceptionHandler#processEvent(jakarta.faces.event.SystemEvent) on the wrapped + ExceptionHandler object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4740 + + void + + jakarta.faces.context.ExceptionHandlerWrapper.processEvent +
+ ( + SystemEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4741 + + void + + jakarta.faces.context.ExternalContext.addResponseCookie +
+ ( + String + , +
+ String + , +
+ Map + ) +
+
+ Adds the cookie represented by the arguments to the response. Jakarta Servlet: This + must be accomplished by calling the jakarta.servlet.http.HttpServletResponse method addCookie(). The + Cookie argument must be constructed by passing the name and value parameters. If the properties + arugument is non-null and not empty, the Cookie instance must be initialized as described below. + Cookie handling table Key in "values" Map (case sensitive) Expected type of value. Name of setter + method on Cookie instance to be set with the value from the Map. comment String setComment domain + String setDomain maxAge Integer setMaxAge secure Boolean setSecure path String setPath httpOnly + Boolean setHttpOnly any other attribute (e.g. SameSite) String setAttribute The default + implementation throws UnsupportedOperationException and is provided for the sole purpose of not + breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4742 + + void + + jakarta.faces.context.ExternalContext.addResponseHeader +
+ ( + String + , +
+ String + ) +
+
+ Add the given name and value to the response header. Jakarta Servlet:This must be + performed by calling the jakarta.servlet.http.HttpServletResponse addHeader method. The default + implementation throws UnsupportedOperationException and is provided for the sole purpose of not + breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4743 + + void + + jakarta.faces.context.ExternalContext.dispatch +
+ ( + String + ) +
+
+ Dispatch a request to the specified resource to create output for this response. + Jakarta Servlet: This must be accomplished by calling the jakarta.servlet.ServletContext method + getRequestDispatcher(path), and calling the forward() method on the resulting object. If the call to + getRequestDisatcher(path) returns null, send aServletResponse SC_NOT_FOUND error code. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4744 + + void + + jakarta.faces.context.ExternalContext.dispatch +
+ ( + String + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4745 + + String + + jakarta.faces.context.ExternalContext.encodeActionURL +
+ ( + String + ) +
+
+ Return the input URL, after performing any rewriting needed to ensure that it will + correctly identify an addressable action in the current application. Encoding the + jakarta.faces.lifecycle.ClientWindow Call + jakarta.faces.lifecycle.ClientWindow#isClientWindowRenderModeEnabled(jakarta.faces.context.FacesContext) + . If the result is false take no further action and return the rewritten URL. If the result is true, + call #getClientWindow(). If the result is non-null, call + jakarta.faces.lifecycle.ClientWindow#getId() and append the id to the query string of the URL, + making the necessary allowances for a pre-existing query string or no query-string. Call + jakarta.faces.lifecycle.ClientWindow#getQueryURLParameters. If the result is non-null, for each + parameter in the map, unconditionally add that parameter to the URL. The name of the query string + parameter is given by the value of the constant + jakarta.faces.render.ResponseStateManager#CLIENT_WINDOW_URL_PARAM. Jakarta Servlet: This must be the + value returned by the jakarta.servlet.http.HttpServletResponse method encodeURL(url). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4746 + + String + + jakarta.faces.context.ExternalContext.encodeBookmarkableURL +
+ ( + String + , +
+ Map + ) +
+
+ The purpose of this method is to generate a query string from the collection of + Parameter objects provided by the parameters argument and append that query string to the baseUrl. + This method must be able to encode the parameters to a baseUrl that may or may not have existing + query parameters. The parameter values should be encoded appropriately for the environment so that + the resulting URL can be used as the target of a link (e.g., in an href attribute) in a Jakarta + Faces response. It's possible for an ExternalContext implementation to override this method in any + way that would make the URL bookmarkable in that environment. See #encodeActionURL(java.lang.String) + for the required specification of how to encode the jakarta.faces.lifecycle.ClientWindow. The + default implementation throws UnsupportedOperationException and is provided for the sole purpose of + not breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4747 + + String + + jakarta.faces.context.ExternalContext.encodeNamespace +
+ ( + String + ) +
+
+ Return the specified name, after prefixing it with a namespace that ensures that it + will be unique within the context of a particular page. Jakarta Servlet: The input value must be + returned unchanged. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4748 + + String + + jakarta.faces.context.ExternalContext.encodePartialActionURL +
+ ( + String + ) +
+
+ Return the input URL, after performing any rewriting needed to ensure that it can be + used in a partial page submission (ajax request) to correctly identify an addressable action in the + current application. See #encodeActionURL(java.lang.String) for the required specification of how to + encode the jakarta.faces.lifecycle.ClientWindow. Jakarta Servlet:Returns the same encoded URL as the + #encodeActionURL(String url) method. Portlet:Returns an encoded URL that, upon HTTP POST, will + invoke the RESOURCE_PHASE of the portlet lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4749 + + String + + jakarta.faces.context.ExternalContext.encodeRedirectURL +
+ ( + String + , +
+ Map + ) +
+
+ The purpose of this method is to generate a query string from the collection of + Parameter objects provided by the parameters argument and append that query string to the baseUrl. + This method must be able to encode the parameters to a baseUrl that may or may not have existing + query parameters. The parameter values should be encoded appropriately for the environment so that + the resulting URL can be used as the target of a redirect. It's possible for an ExternalContext + implementation to override this method to accomodate the definition of redirect for that + environment. See #encodeActionURL(java.lang.String) for the required specification of how to encode + the jakarta.faces.lifecycle.ClientWindow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4750 + + String + + jakarta.faces.context.ExternalContext.encodeResourceURL +
+ ( + String + ) +
+
+ Return the input URL, after performing any rewriting needed to ensure that it will + correctly identify an addressable resource in the current application. Jakarta Servlet: This must be + the value returned by the jakarta.servlet.http.HttpServletResponse method encodeURL(url). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4751 + + String + + jakarta.faces.context.ExternalContext.encodeWebsocketURL +
+ ( + String + ) +
+
+ Return the websocket URL, after performing any rewriting needed to ensure that it will + correctly identify an addressable websocket in the current application. Jakarta Servlet: This must + ensure that the input URL is prefixed with the correct websocket scheme, domain and port and then + encoded by #encodeResourceURL(String). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4752 + + ExternalContext + + jakarta.faces.context.ExternalContext.ExternalContext +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4753 + + String + + jakarta.faces.context.ExternalContext.getApplicationContextPath +
+
+
+ Return the name of the container context for this application. Jakarta Servlet: Return + the result of calling getContextPath() on the ServletContext instance for this application. It is + valid to call this method during application startup or shutdown. The default implementation throws + UnsupportedOperationException and is provided for the sole purpose of not breaking existing + applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4754 + + Map + + jakarta.faces.context.ExternalContext.getApplicationMap +
+
+
+ Return a mutable Map representing the application scope attributes for the current + application. The returned Map must implement the entire contract for a modifiable map as described + in the JavaDocs for java.util.Map. Modifications made in the Map must cause the corresponding + changes in the set of application scope attributes. Particularly the clear(), remove(), put(), + putAll(), and get() operations must take the appropriate action on the underlying data structure. It + is valid to call this method during application startup or shutdown. If called at startup or + shutdown time, this method returns a Map that is backed by the same container context instance + (ServletContext or PortletContext) as the one returned by calling getApplicationMap() on the + ExternalContext returned by the FacesContext during an actual request. Jakarta Servlet: This must be + the set of attributes available via the jakarta.servlet.ServletContext methods getAttribute(), + getAttributeNames(), removeAttribute(), and setAttribute(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4755 + + String + + jakarta.faces.context.ExternalContext.getAuthType +
+
+
+ Return the name of the authentication scheme used to authenticate the current user, if + any; otherwise, return null. For standard authentication schemes, the returned value will match one + of the following constants: BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, or FORM_AUTH. Jakarta + Servlet: This must be the value returned by the jakarta.servlet.http.HttpServletRequest method + getAuthType(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4756 + + ClientWindow + + jakarta.faces.context.ExternalContext.getClientWindow +
+
+
+ Return the ClientWindow set in a preceding call to #setClientWindow, or null if no such + call has been made. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4757 + + Object + + jakarta.faces.context.ExternalContext.getContext +
+
+
+ Return the application environment object instance for the current appication. It is + valid to call this method during application startup or shutdown. If called during application + startup or shutdown, this returns the same container context instance (ServletContext or + PortletContext) as the one returned when calling getContext() on the ExternalContext returned by the + FacesContext during an actual request. Jakarta Servlet: This must be the current application's + jakarta.servlet.ServletContext instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4758 + + String + + jakarta.faces.context.ExternalContext.getContextName +
+
+
+ Return the name of the container context for this application. Return the result of + calling getServletContextName() on the ServletContext instance for this application. It is valid to + call this method during application startup or shutdown. The default implementation throws + UnsupportedOperationException and is provided for the sole purpose of not breaking existing + applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4759 + + Flash + + jakarta.faces.context.ExternalContext.getFlash +
+
+
+ Return the threadsafe Flash for this application. The default implementation will throw + UnsupportedOperationException. Compliant Jakarta Faces runtimes must provide an implementation of + this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4760 + + String + + jakarta.faces.context.ExternalContext.getInitParameter +
+ ( + String + ) +
+
+ Return the value of the specified application initialization parameter (if any). + Jakarta Servlet: This must be the result of the jakarta.servlet.ServletContext method + getInitParameter(name). It is valid to call this method during application startup or shutdown. If + called during application startup or shutdown, this method calls through to the actual container + context to return the init parameter value. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4761 + + Map + + jakarta.faces.context.ExternalContext.getInitParameterMap +
+
+
+ Return an immutable Map whose keys are the set of application initialization parameter + names configured for this application, and whose values are the corresponding parameter values. The + returned Map must implement the entire contract for an unmodifiable map as described in the JavaDocs + for java.util.Map. It is valid to call this method during application startup or shutdown. If called + during application startup or shutdown, this method returns a Map that is backed by the same + container context instance (ServletContext or PortletContext) as the one returned by calling + getInitParameterMap() on the ExternalContext returned by the FacesContext during an actual request. + Jakarta Servlet: This result must be as if it were synthesized by calling the + jakarta.servlet.ServletContext method getInitParameterNames, and putting each configured parameter + name/value pair into the result. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4762 + + String + + jakarta.faces.context.ExternalContext.getMimeType +
+ ( + String + ) +
+
+ Returns the MIME type of the specified file or null if the MIME type is not known. The + MIME type is determined by the container. It is valid to call this method during application startup + or shutdown. If called during application startup or shutdown, this method calls through to the + getMimeType() method on the same container context instance (ServletContext or PortletContext) as + the one used when calling getMimeType() on the ExternalContext returned by the FacesContext during + an actual request. Jakarta Servlet: This must be the value returned by the + jakarta.servlet.ServletContext method getMimeType(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4763 + + String + + jakarta.faces.context.ExternalContext.getRealPath +
+ ( + String + ) +
+
+ Returns a String containing the real path for a given virtual path. It is valid to call + this method during application startup or shutdown. If called during application startup or + shutdown, this method calls through to the getRealPath() method on the same container context + instance (ServletContext or PortletContext) as the one used when calling getRealPath() on the + ExternalContext returned by the FacesContext during an actual request. Jakarta Servlet: This must be + the value returned by the jakarta.servlet.ServletContext method getRealPath(). The default + implementation throws UnsupportedOperationException and is provided for the sole purpose of not + breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4764 + + String + + jakarta.faces.context.ExternalContext.getRemoteUser +
+
+
+ Return the login name of the user making the current request if any; otherwise, return + null. Jakarta Servlet: This must be the value returned by the + jakarta.servlet.http.HttpServletRequest method getRemoteUser(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4765 + + Object + + jakarta.faces.context.ExternalContext.getRequest +
+
+
+ Return the environment-specific object instance for the current request. Jakarta + Servlet: This must be the current request's jakarta.servlet.http.HttpServletRequest instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4766 + + String + + jakarta.faces.context.ExternalContext.getRequestCharacterEncoding +
+
+
+ Return the character encoding currently being used to interpret this request. Jakarta + Servlet: This must return the value returned by the jakarta.servlet.ServletRequest method + getCharacterEncoding(). The default implementation throws UnsupportedOperationException and is + provided for the sole purpose of not breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4767 + + int + + jakarta.faces.context.ExternalContext.getRequestContentLength +
+
+
+ Return the result of calling getContentLenth() on the ServletRequest instance for this + request. The default implementation throws UnsupportedOperationException and is provided for the + sole purpose of not breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4768 + + String + + jakarta.faces.context.ExternalContext.getRequestContentType +
+
+
+ Return the MIME Content-Type for this request. If not available, return null. Jakarta + Servlet: This must return the value returned by the jakarta.servlet.ServletRequest method + getContentType(). The default implementation throws UnsupportedOperationException and is provided + for the sole purpose of not breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4769 + + String + + jakarta.faces.context.ExternalContext.getRequestContextPath +
+
+
+ Return the portion of the request URI that identifies the web application context for + this request. Jakarta Servlet: This must be the value returned by the + jakarta.servlet.http.HttpServletRequest method getContextPath(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4770 + + Map + + jakarta.faces.context.ExternalContext.getRequestCookieMap +
+
+
+ Return an immutable Map whose keys are the set of cookie names included in the current + request, and whose values (of type jakarta.servlet.http.Cookie) are the first (or only) cookie for + each cookie name returned by the underlying request. The returned Map must implement the entire + contract for an unmodifiable map as described in the JavaDocs for java.util.Map. Jakarta Servlet: + This must be the value returned by the jakarta.servlet.http.HttpServletRequest method getCookies(), + unless null was returned, in which case this must be a zero-length array. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4771 + + Map + + jakarta.faces.context.ExternalContext.getRequestHeaderMap +
+
+
+ Return an immutable Map whose keys are the set of request header names included in the + current request, and whose values (of type String) are the first (or only) value for each header + name returned by the underlying request. The returned Map must implement the entire contract for an + unmodifiable map as described in the JavaDocs for java.util.Map. In addition, key comparisons must + be performed in a case insensitive manner. Jakarta Servlet: This must be the set of headers + available via the jakarta.servlet.http.HttpServletRequest methods getHeader() and getHeaderNames(). + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4772 + + Map + + jakarta.faces.context.ExternalContext.getRequestHeaderValuesMap +
+
+
+ Return an immutable Map whose keys are the set of request header names included in the + current request, and whose values (of type String[]) are all of the value for each header name + returned by the underlying request. The returned Map must implement the entire contract for an + unmodifiable map as described in the JavaDocs for java.util.Map. In addition, key comparisons must + be performed in a case insensitive manner. Jakarta Servlet: This must be the set of headers + available via the jakarta.servlet.http.HttpServletRequest methods getHeaders() and getHeaderNames(). + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4773 + + Locale + + jakarta.faces.context.ExternalContext.getRequestLocale +
+
+
+ Return the preferred Locale in which the client will accept content. Jakarta Servlet: + This must be the value returned by the jakarta.servlet.ServletRequest method getLocale(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4774 + + Iterator + + jakarta.faces.context.ExternalContext.getRequestLocales +
+
+
+ Return an Iterator over the preferred Locales specified in the request, in decreasing + order of preference. Jakarta Servlet: This must be an Iterator over the values returned by the + jakarta.servlet.ServletRequest method getLocales(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4775 + + Map + + jakarta.faces.context.ExternalContext.getRequestMap +
+
+
+ Return a mutable Map representing the request scope attributes for the current + application. The returned Map must implement the entire contract for a modifiable map as described + in the JavaDocs for java.util.Map. Modifications made in the Map must cause the corresponding + changes in the set of request scope attributes. Particularly the clear(), remove(), put(), putAll(), + and get() operations must take the appropriate action on the underlying data structure. Jakarta + Servlet: This must be the set of attributes available via the jakarta.servlet.ServletRequest methods + getAttribute(), getAttributeNames(), removeAttribute(), and setAttribute(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4776 + + Map + + jakarta.faces.context.ExternalContext.getRequestParameterMap +
+
+
+ Return an immutable Map whose keys are the set of request parameters names included in + the current request, and whose values (of type String) are the first (or only) value for each + parameter name returned by the underlying request. The returned Map must implement the entire + contract for an unmodifiable map as described in the JavaDocs for java.util.Map. Jakarta Servlet: + This must be the set of parameters available via the jakarta.servlet.ServletRequest methods + getParameter() and getParameterNames(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4777 + + Iterator + + jakarta.faces.context.ExternalContext.getRequestParameterNames +
+
+
+ Return an Iterator over the names of all request parameters included in the current + request. Jakarta Servlet: This must be an Iterator over the values returned by the + jakarta.servlet.ServletRequest method getParameterNames(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4778 + + Map + + jakarta.faces.context.ExternalContext.getRequestParameterValuesMap +
+
+
+ Return an immutable Map whose keys are the set of request parameters names included in + the current request, and whose values (of type String[]) are all of the values for each parameter + name returned by the underlying request. The returned Map must implement the entire contract for an + unmodifiable map as described in the JavaDocs for java.util.Map. Jakarta Servlet: This must be the + set of parameters available via the jakarta.servlet.ServletRequest methods getParameterValues() and + getParameterNames(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4779 + + String + + jakarta.faces.context.ExternalContext.getRequestPathInfo +
+
+
+ Return the extra path information (if any) included in the request URI; otherwise, + return null. Jakarta Servlet: This must be the value returned by the + jakarta.servlet.http.HttpServletRequest method getPathInfo(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4780 + + String + + jakarta.faces.context.ExternalContext.getRequestScheme +
+
+
+ Returns the name of the scheme used to make this request, for example, http, https, or + ftp. Jakarta Servlet: This must be the value returned by the jakarta.servlet.ServletRequest method + getScheme(). The default implementation throws UnsupportedOperationException and is provided for the + sole purpose of not breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4781 + + String + + jakarta.faces.context.ExternalContext.getRequestServerName +
+
+
+ Returns the host name of the server to which the request was sent. Jakarta Servlet: + This must be the value returned by the jakarta.servlet.ServletRequest method getServerName(). The + default implementation throws UnsupportedOperationException and is provided for the sole purpose of + not breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4782 + + int + + jakarta.faces.context.ExternalContext.getRequestServerPort +
+
+
+ Returns the port number to which the request was sent. Jakarta Servlet: This must be + the value returned by the jakarta.servlet.ServletRequest method getServerPort(). The default + implementation throws UnsupportedOperationException and is provided for the sole purpose of not + breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4783 + + String + + jakarta.faces.context.ExternalContext.getRequestServletPath +
+
+
+ Return the Jakarta Servlet path information (if any) included in the request URI; + otherwise, return null. Jakarta Servlet: This must be the value returned by the + jakarta.servlet.http.HttpServletRequest method getServletPath(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4784 + + URL + + jakarta.faces.context.ExternalContext.getResource +
+ ( + String + ) +
+
+ Return a URL for the application resource mapped to the specified path, if it exists; + otherwise, return null. It is valid to call this method during application startup or shutdown. If + called during application startup or shutdown, this method calls through to the getResource() method + on the same container context instance (ServletContext or PortletContext) as the one used when + calling getResource() on the ExternalContext returned by the FacesContext during an actual request. + Jakarta Servlet: This must be the value returned by the jakarta.servlet.ServletContext method + getResource(path). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4785 + + URL + + jakarta.faces.context.ExternalContext.getResource +
+ ( + String + ) + +
+ throws + MalformedURLException +
+
+
+ if the specified path is not in the correct form + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4786 + + InputStream + + jakarta.faces.context.ExternalContext.getResourceAsStream +
+ ( + String + ) +
+
+ Return an InputStream for an application resource mapped to the specified path, if it + exists; otherwise, return null. It is valid to call this method during application startup or + shutdown. If called during application startup or shutdown, this method calls through to the + getResourceAsStream() method on the same container context instance (ServletContext or + PortletContext) as the one used when calling getResourceAsStream() on the ExternalContext returned + by the FacesContext during an actual request. Jakarta Servlet: This must be the value returned by + the jakarta.servlet.ServletContext method getResourceAsStream(path). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4787 + + Set + + jakarta.faces.context.ExternalContext.getResourcePaths +
+ ( + String + ) +
+
+ Return the Set of resource paths for all application resources whose resource path + starts with the specified argument. It is valid to call this method during application startup or + shutdown. If called during application startup or shutdown, this method calls through to the + getResourcePaths() method on the same container context instance (ServletContext or PortletContext) + as the one used when calling getResourcePaths() on the ExternalContext returned by the FacesContext + during an actual request. Jakarta Servlet: This must be the value returned by the + jakarta.servlet.ServletContext method getResourcePaths(path). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4788 + + Object + + jakarta.faces.context.ExternalContext.getResponse +
+
+
+ Return the environment-specific object instance for the current response. Jakarta + Servlet: This is the current request's jakarta.servlet.http.HttpServletResponse instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4789 + + int + + jakarta.faces.context.ExternalContext.getResponseBufferSize +
+
+
+ Return the buffer size for the current response. Jakarta Servlet: This must be + performed by calling the jakarta.servlet.http.HttpServletResponse getBufferSize method. The default + implementation throws UnsupportedOperationException and is provided for the sole purpose of not + breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4790 + + String + + jakarta.faces.context.ExternalContext.getResponseCharacterEncoding +
+
+
+ Returns the name of the character encoding (MIME charset) used for the body sent in + this response. Jakarta Servlet: This must return the value returned by the + jakarta.servlet.ServletResponse method getCharacterEncoding(). Portlet: if this method is called + during a lifecycle phase other than RENDER_RESPONSE, this must return null. If called during + RENDER_RESPONSE, return the response encoding of the portlet response. The default implementation + throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing + applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4791 + + String + + jakarta.faces.context.ExternalContext.getResponseContentType +
+
+
+ Return the MIME Content-Type for this response. If not available, return null. Jakarta + Servlet: This must return the value returned by the jakarta.servlet.ServletResponse method + getContentType(). The default implementation throws UnsupportedOperationException and is provided + for the sole purpose of not breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4792 + + OutputStream + + jakarta.faces.context.ExternalContext.getResponseOutputStream +
+
+
+ Returns an OutputStream suitable for writing binary data to the user-agent. Jakarta + Servlet: This must return the value returned by the jakarta.servlet.ServletResponse method + getOutputStream(). The default implementation throws UnsupportedOperationException and is provided + for the sole purpose of not breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4793 + + OutputStream + + jakarta.faces.context.ExternalContext.getResponseOutputStream +
+
+ throws + IOException +
+
+
+ any IO related exception. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4794 + + Writer + + jakarta.faces.context.ExternalContext.getResponseOutputWriter +
+
+
+ Returns a Writer suitable for writing character data to the user-agent. Jakarta + Servlet: This must return the value returned by the jakarta.servlet.ServletResponse#getWriter. The + default implementation throws UnsupportedOperationException and is provided for the sole purpose of + not breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4795 + + Writer + + jakarta.faces.context.ExternalContext.getResponseOutputWriter +
+
+ throws + IOException +
+
+
+ any IO related exception. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4796 + + Object + + jakarta.faces.context.ExternalContext.getSession +
+ ( + boolean + ) +
+
+ If the create parameter is true, create (if necessary) and return a session instance + associated with the current request. If the create parameter is false return any existing session + instance associated with the current request, or return null if there is no such session. Jakarta + Servlet: This must return the result of calling getSession(create) on the underlying + jakarta.servlet.http.HttpServletRequest instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4797 + + String + + jakarta.faces.context.ExternalContext.getSessionId +
+ ( + boolean + ) +
+
+ Return the id of the current session or the empty string if no session has been created + and the create parameter is false. Jakarta Servlet: If create is true, obtain a reference to the + HttpSession for the current request (creating the session if necessary) and return its id. If create + is false, obtain a reference to the current session, if one exists, and return its id. If no session + exists, return the empty string. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4798 + + Map + + jakarta.faces.context.ExternalContext.getSessionMap +
+
+
+ Return a mutable Map representing the session scope attributes for the current + application. The returned Map must implement the entire contract for a modifiable map as described + in the JavaDocs for java.util.Map. Modifications made in the Map must cause the corresponding + changes in the set of session scope attributes. Particularly the clear(), remove(), put(), and get() + operations must take the appropriate action on the underlying data structure. Accessing attributes + via this Map must cause the creation of a session associated with the current request, if such a + session does not already exist. Jakarta Servlet: This must be the set of attributes available via + the jakarta.servlet.http.HttpSession methods getAttribute(), getAttributeNames(), removeAttribute(), + and setAttribute(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4799 + + int + + jakarta.faces.context.ExternalContext.getSessionMaxInactiveInterval +
+
+
+ Returns the maximum time interval, in seconds, that the Jakarta Servlet container will + keep this session open between client accesses. After this interval, the Jakarta Servlet container + will invalidate the session. The maximum time interval can be set with the + #setSessionMaxInactiveInterval method. A return value of zero or less indicates that the session + will never timeout. Jakarta Servlet: This must return the result of calling getMaxInactiveInterval + on the underlying jakarta.servlet.http.HttpSession instance. The default implementation throws + UnsupportedOperationException and is provided for the sole purpose of not breaking existing + applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4800 + + Principal + + jakarta.faces.context.ExternalContext.getUserPrincipal +
+
+
+ Return the Principal object containing the name of the current authenticated user, if + any; otherwise, return null. Jakarta Servlet: This must be the value returned by the + jakarta.servlet.http.HttpServletRequest method getUserPrincipal(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4801 + + void + + jakarta.faces.context.ExternalContext.invalidateSession +
+
+
+ Invalidates this session then unbinds any objects bound to it. Jakarta Servlet: This + must be the value returned by the jakarta.servlet.http.HttpSession method invalidate(). The default + implementation throws UnsupportedOperationException and is provided for the sole purpose of not + breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4802 + + boolean + + jakarta.faces.context.ExternalContext.isResponseCommitted +
+
+
+ Check if the current response has been committed. Jakarta Servlet: This must be + performed by calling the jakarta.servlet.http.HttpServletResponse isCommitted method. The default + implementation throws UnsupportedOperationException and is provided for the sole purpose of not + breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4803 + + boolean + + jakarta.faces.context.ExternalContext.isSecure +
+
+
+ Returns a boolean indicating whether this request was made using a secure channel, such + as HTTPS. Jakarta Servlet: This must return the result of calling isSecure on the underlying + jakarta.servlet.http.HttpServletRequest instance. The default implementation throws + UnsupportedOperationException and is provided for the sole purpose of not breaking existing + applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4804 + + boolean + + jakarta.faces.context.ExternalContext.isUserInRole +
+ ( + String + ) +
+
+ Return true if the currently authenticated user is included in the specified role. + Otherwise, return false. Jakarta Servlet: This must be the value returned by the + jakarta.servlet.http.HttpServletRequest method isUserInRole(role). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4805 + + void + + jakarta.faces.context.ExternalContext.log +
+ ( + String + ) +
+
+ Log the specified message to the application object. It is valid to call this method + during application startup or shutdown. If called during application startup or shutdown, this calls + the log() method on the same container context instance (ServletContext or PortletContext) as the + one used during a call to log() on the ExternalContext returned by the FacesContext during an actual + request. Jakarta Servlet: This must be performed by calling the jakarta.servlet.ServletContext + method log(String). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4806 + + void + + jakarta.faces.context.ExternalContext.log +
+ ( + String + , +
+ Throwable + ) +
+
+ Log the specified message and exception to the application object. It is valid to call + this method during application startup or shutdown. If called during application startup or + shutdown, this calls the log() method on the same container context instance (ServletContext or + PortletContext) as the one used when calling log() on the ExternalContext returned by the + FacesContext during an actual request. Jakarta Servlet: This must be performed by calling the + jakarta.servlet.ServletContext method log(String,Throwable). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4807 + + void + + jakarta.faces.context.ExternalContext.redirect +
+ ( + String + ) +
+
+ Redirect a request to the specified URL, and cause the responseComplete() method to be + called on the FacesContext instance for the current request. The implementation must determine if + the request is an Ajax request by obtaining a PartialViewContext instance from the FacesContext and + calling PartialViewContext#isAjaxRequest(). Jakarta Servlet: For non Ajax requests, this must be + accomplished by calling the jakarta.servlet.http.HttpServletResponse method sendRedirect(). For Ajax + requests, the implementation must: Get a PartialResponseWriter instance from the FacesContext. Call + #setResponseContentType with text/xml Call #setResponseCharacterEncoding with UTF-8 Call + #addResponseHeader with Cache-Control, no-cache Call PartialResponseWriter#startDocument Call + PartialResponseWriter#redirect with the url argument. Call PartialResponseWriter#endDocument + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4808 + + void + + jakarta.faces.context.ExternalContext.redirect +
+ ( + String + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4809 + + void + + jakarta.faces.context.ExternalContext.release +
+
+
+ Release any resources associated with this ExternalContext instance. This method is + called during during destruction of the associated FacesContext. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4810 + + void + + jakarta.faces.context.ExternalContext.responseFlushBuffer +
+
+
+ Flushes the buffered response content to the client. Jakarta Servlet: This must be + performed by calling the jakarta.servlet.http.HttpServletResponse flushBuffer method. The default + implementation throws UnsupportedOperationException and is provided for the sole purpose of not + breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4811 + + void + + jakarta.faces.context.ExternalContext.responseFlushBuffer +
+
+ throws + IOException +
+
+
+ any IO related exception. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4812 + + void + + jakarta.faces.context.ExternalContext.responseReset +
+
+
+ Resets the current response. Jakarta Servlet: This must be performed by calling the + jakarta.servlet.http.HttpServletResponse reset method. The default implementation throws + UnsupportedOperationException and is provided for the sole purpose of not breaking existing + applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4813 + + void + + jakarta.faces.context.ExternalContext.responseSendError +
+ ( + int + , +
+ String + ) +
+
+ Sends an HTTP status code with message. Jakarta Servlet: This must be performed by + calling the jakarta.servlet.http.HttpServletResponse sendError method. The default implementation + throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing + applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4814 + + void + + jakarta.faces.context.ExternalContext.responseSendError +
+ ( + int + , +
+ String + ) + +
+ throws + IOException +
+
+
+ any IO related exceptions. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4815 + + void + + jakarta.faces.context.ExternalContext.setClientWindow +
+ ( + ClientWindow + ) +
+
+ Associate this instance with a ClientWindow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4816 + + void + + jakarta.faces.context.ExternalContext.setRequest +
+ ( + Object + ) +
+
+ Set the environment-specific request to be returned by subsequent calls to #getRequest. + This may be used to install a wrapper for the request. The default implementation throws + UnsupportedOperationException and is provided for the sole purpose of not breaking existing + applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4817 + + void + + jakarta.faces.context.ExternalContext.setRequestCharacterEncoding +
+ ( + String + ) +
+
+ Overrides the name of the character encoding used in the body of this request. Calling + this method after the request has been accessed will have no no effect, unless a Reader or Stream + has been obtained from the request, in which case an IllegalStateException is thrown. Jakarta + Servlet: This must call through to the jakarta.servlet.ServletRequest method setCharacterEncoding(). + The default implementation throws UnsupportedOperationException and is provided for the sole purpose + of not breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4818 + + void + + jakarta.faces.context.ExternalContext.setRequestCharacterEncoding +
+ ( + String + ) + +
+ throws + UnsupportedEncodingException +
+
+
+ if this is not a valid encoding + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4819 + + void + + jakarta.faces.context.ExternalContext.setResponse +
+ ( + Object + ) +
+
+ Set the environment-specific response to be returned by subsequent calls to + #getResponse. This may be used to install a wrapper for the response. The default implementation + throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing + applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4820 + + void + + jakarta.faces.context.ExternalContext.setResponseBufferSize +
+ ( + int + ) +
+
+ Set the buffer size for the current response. Jakarta Servlet: This must be performed + by calling the jakarta.servlet.http.HttpServletResponse setBufferSize method. The default + implementation throws UnsupportedOperationException and is provided for the sole purpose of not + breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4821 + + void + + jakarta.faces.context.ExternalContext.setResponseCharacterEncoding +
+ ( + String + ) +
+
+ Sets the character encoding (MIME charset) of the response being sent to the client, + for example, to UTF-8. Jakarta Servlet: This must call through to the + jakarta.servlet.ServletResponse method setCharacterEncoding(). The default implementation throws + UnsupportedOperationException and is provided for the sole purpose of not breaking existing + applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4822 + + void + + jakarta.faces.context.ExternalContext.setResponseContentLength +
+ ( + int + ) +
+
+ Set the content length of the response. Jakarta Servlet: This must be performed by + calling the jakarta.servlet.http.HttpServletResponse setContentLength method. The default + implementation throws UnsupportedOperationException and is provided for the sole purpose of not + breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4823 + + void + + jakarta.faces.context.ExternalContext.setResponseContentType +
+ ( + String + ) +
+
+ Sets the content type of the response being sent to the client, if the response has not + been committed yet. Jakarta Servlet: This must call setContentType() on the underlying + jakarta.servlet.ServletResponse instance. The default implementation throws + UnsupportedOperationException and is provided for the sole purpose of not breaking existing + applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4824 + + void + + jakarta.faces.context.ExternalContext.setResponseHeader +
+ ( + String + , +
+ String + ) +
+
+ Set the response header with the given name and value. Jakarta Servlet:This must be + performed by calling the jakarta.servlet.http.HttpServletResponse setHeader method. The default + implementation throws UnsupportedOperationException and is provided for the sole purpose of not + breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4825 + + void + + jakarta.faces.context.ExternalContext.setResponseStatus +
+ ( + int + ) +
+
+ Sets the HTTP status code for the response. Jakarta Servlet: This must be performed by + calling the jakarta.servlet.http.HttpServletResponse setStatus method. The default implementation + throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing + applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4826 + + void + + jakarta.faces.context.ExternalContext.setSessionMaxInactiveInterval +
+ ( + int + ) +
+
+ Specifies the time, in seconds, between client requests before the Jakarta Servlet + container will invalidate this session. An interval value of zero or less indicates that the session + should never timeout. Jakarta Servlet: This must call setMaxInactiveInterval on the underlying + jakarta.servlet.http.HttpServletRequest instance. The default implementation throws + UnsupportedOperationException and is provided for the sole purpose of not breaking existing + applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4827 + + ExternalContextFactory + + jakarta.faces.context.ExternalContextFactory.ExternalContextFactory +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:4828 + + ExternalContextFactory + + jakarta.faces.context.ExternalContextFactory.ExternalContextFactory +
+ ( + ExternalContextFactory + ) +
+
+ If this factory has been decorated, the implementation doing the decorating should push + the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4829 + + ExternalContext + + jakarta.faces.context.ExternalContextFactory.getExternalContext +
+ ( + Object + , +
+ Object + , +
+ Object + ) +
+
+ Create (if needed) and return an ExternalContext instance that is initialized for the + processing of the specified request and response objects, for this web application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4830 + + ExternalContext + + jakarta.faces.context.ExternalContextFactory.getExternalContext +
+ ( + Object + , +
+ Object + , +
+ Object + ) + +
+ throws + FacesException +
+
+
+ if a ExternalContext cannot be constructed for the specified parameters + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4831 + + ExternalContextFactory + + jakarta.faces.context.ExternalContextFactory.getWrapped +
+
+
+ If this factory has been decorated, the implementation doing the decorating may + override this method to provide access to the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4832 + + void + + jakarta.faces.context.ExternalContextWrapper.addResponseCookie +
+ ( + String + , +
+ String + , +
+ Map + ) +
+
+ The default behavior of this method is to call + ExternalContext#addResponseCookie(String, String, Map) on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4833 + + void + + jakarta.faces.context.ExternalContextWrapper.addResponseHeader +
+ ( + String + , +
+ String + ) +
+
+ The default behavior of this method is to call + ExternalContext#addResponseHeader(String,String) on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4834 + + void + + jakarta.faces.context.ExternalContextWrapper.dispatch +
+ ( + String + ) +
+
+ The default behavior of this method is to call ExternalContext#dispatch(String) on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4835 + + void + + jakarta.faces.context.ExternalContextWrapper.dispatch +
+ ( + String + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4836 + + String + + jakarta.faces.context.ExternalContextWrapper.encodeActionURL +
+ ( + String + ) +
+
+ The default behavior of this method is to call ExternalContext#encodeActionURL(String) + on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4837 + + String + + jakarta.faces.context.ExternalContextWrapper.encodeBookmarkableURL +
+ ( + String + , +
+ Map + ) +
+
+ The default behavior of this method is to call + jakarta.faces.context.ExternalContext#encodeBookmarkableURL(String, java.util.Map) on the wrapped + ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4838 + + String + + jakarta.faces.context.ExternalContextWrapper.encodeNamespace +
+ ( + String + ) +
+
+ The default behavior of this method is to call ExternalContext#encodeNamespace(String) + on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4839 + + String + + jakarta.faces.context.ExternalContextWrapper.encodePartialActionURL +
+ ( + String + ) +
+
+ The default behavior of this method is to call + ExternalContext#encodePartialActionURL(String) on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4840 + + String + + jakarta.faces.context.ExternalContextWrapper.encodeRedirectURL +
+ ( + String + , +
+ Map + ) +
+
+ The default behavior of this method is to call + jakarta.faces.context.ExternalContext#encodeRedirectURL(String, java.util.Map) on the wrapped + ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4841 + + String + + jakarta.faces.context.ExternalContextWrapper.encodeResourceURL +
+ ( + String + ) +
+
+ The default behavior of this method is to call + ExternalContext#encodeResourceURL(String) on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4842 + + String + + jakarta.faces.context.ExternalContextWrapper.encodeWebsocketURL +
+ ( + String + ) +
+
+ The default behavior of this method is to call + ExternalContext#encodeWebsocketURL(String) on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4843 + + ExternalContextWrapper + + jakarta.faces.context.ExternalContextWrapper.ExternalContextWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:4844 + + ExternalContextWrapper + + jakarta.faces.context.ExternalContextWrapper.ExternalContextWrapper +
+ ( + ExternalContext + ) +
+
+ If this external context has been decorated, the implementation doing the decorating + should push the implementation being wrapped to this constructor. The #getWrapped() will then return + the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4845 + + String + + jakarta.faces.context.ExternalContextWrapper.getApplicationContextPath +
+
+
+ The default behavior of this method is to call + ExternalContext#getApplicationContextPath on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4846 + + Map + + jakarta.faces.context.ExternalContextWrapper.getApplicationMap +
+
+
+ The default behavior of this method is to call ExternalContext#getApplicationMap on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4847 + + String + + jakarta.faces.context.ExternalContextWrapper.getAuthType +
+
+
+ The default behavior of this method is to call ExternalContext#getAuthType on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4848 + + ClientWindow + + jakarta.faces.context.ExternalContextWrapper.getClientWindow +
+
+
+ The default behavior of this method is to call ExternalContext#getClientWindow on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4849 + + Object + + jakarta.faces.context.ExternalContextWrapper.getContext +
+
+
+ The default behavior of this method is to call ExternalContext#getContext on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4850 + + String + + jakarta.faces.context.ExternalContextWrapper.getContextName +
+
+
+ The default behavior of this method is to call ExternalContext#getContextName on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4851 + + Flash + + jakarta.faces.context.ExternalContextWrapper.getFlash +
+
+
+ The default behavior of this method is to call ExternalContext#getFlash() on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4852 + + String + + jakarta.faces.context.ExternalContextWrapper.getInitParameter +
+ ( + String + ) +
+
+ The default behavior of this method is to call ExternalContext#getInitParameter(String) + on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4853 + + Map + + jakarta.faces.context.ExternalContextWrapper.getInitParameterMap +
+
+
+ The default behavior of this method is to call ExternalContext#getInitParameterMap on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4854 + + String + + jakarta.faces.context.ExternalContextWrapper.getMimeType +
+ ( + String + ) +
+
+ The default behavior of this method is to call ExternalContext#getMimeType(String) on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4855 + + String + + jakarta.faces.context.ExternalContextWrapper.getRealPath +
+ ( + String + ) +
+
+ The default behavior of this method is to call ExternalContext#getRealPath(String) on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4856 + + String + + jakarta.faces.context.ExternalContextWrapper.getRemoteUser +
+
+
+ The default behavior of this method is to call ExternalContext#getRemoteUser on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4857 + + Object + + jakarta.faces.context.ExternalContextWrapper.getRequest +
+
+
+ The default behavior of this method is to call ExternalContext#getRequest on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4858 + + String + + jakarta.faces.context.ExternalContextWrapper.getRequestCharacterEncoding +
+
+
+ The default behavior of this method is to call + ExternalContext#getRequestCharacterEncoding on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4859 + + int + + jakarta.faces.context.ExternalContextWrapper.getRequestContentLength +
+
+
+ The default behavior of this method is to call ExternalContext#getRequestContentLength + on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4860 + + String + + jakarta.faces.context.ExternalContextWrapper.getRequestContentType +
+
+
+ The default behavior of this method is to call ExternalContext#getRequestContentType on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4861 + + String + + jakarta.faces.context.ExternalContextWrapper.getRequestContextPath +
+
+
+ The default behavior of this method is to call ExternalContext#getRequestContextPath on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4862 + + Map + + jakarta.faces.context.ExternalContextWrapper.getRequestCookieMap +
+
+
+ The default behavior of this method is to call ExternalContext#getRequestCookieMap on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4863 + + Map + + jakarta.faces.context.ExternalContextWrapper.getRequestHeaderMap +
+
+
+ The default behavior of this method is to call ExternalContext#getRequestHeaderMap on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4864 + + Map + + jakarta.faces.context.ExternalContextWrapper.getRequestHeaderValuesMap +
+
+
+ The default behavior of this method is to call + ExternalContext#getRequestHeaderValuesMap on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4865 + + Locale + + jakarta.faces.context.ExternalContextWrapper.getRequestLocale +
+
+
+ The default behavior of this method is to call ExternalContext#getRequestLocale on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4866 + + Iterator + + jakarta.faces.context.ExternalContextWrapper.getRequestLocales +
+
+
+ The default behavior of this method is to call ExternalContext#getRequestLocales on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4867 + + Map + + jakarta.faces.context.ExternalContextWrapper.getRequestMap +
+
+
+ The default behavior of this method is to call ExternalContext#getRequestMap on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4868 + + Map + + jakarta.faces.context.ExternalContextWrapper.getRequestParameterMap +
+
+
+ The default behavior of this method is to call ExternalContext#getRequestParameterMap + on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4869 + + Iterator + + jakarta.faces.context.ExternalContextWrapper.getRequestParameterNames +
+
+
+ The default behavior of this method is to call ExternalContext#getRequestParameterNames + on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4870 + + Map + + jakarta.faces.context.ExternalContextWrapper.getRequestParameterValuesMap +
+
+
+ The default behavior of this method is to call + ExternalContext#getRequestParameterValuesMap on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4871 + + String + + jakarta.faces.context.ExternalContextWrapper.getRequestPathInfo +
+
+
+ The default behavior of this method is to call ExternalContext#getRequestPathInfo on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4872 + + String + + jakarta.faces.context.ExternalContextWrapper.getRequestScheme +
+
+
+ The default behavior of this method is to call ExternalContext#getRequestScheme on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4873 + + String + + jakarta.faces.context.ExternalContextWrapper.getRequestServerName +
+
+
+ The default behavior of this method is to call ExternalContext#getRequestServerName on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4874 + + int + + jakarta.faces.context.ExternalContextWrapper.getRequestServerPort +
+
+
+ The default behavior of this method is to call ExternalContext#getRequestServerPort on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4875 + + String + + jakarta.faces.context.ExternalContextWrapper.getRequestServletPath +
+
+
+ The default behavior of this method is to call ExternalContext#getRequestServletPath on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4876 + + URL + + jakarta.faces.context.ExternalContextWrapper.getResource +
+ ( + String + ) +
+
+ The default behavior of this method is to call ExternalContext#getResource(String) on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4877 + + URL + + jakarta.faces.context.ExternalContextWrapper.getResource +
+ ( + String + ) + +
+ throws + MalformedURLException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4878 + + InputStream + + jakarta.faces.context.ExternalContextWrapper.getResourceAsStream +
+ ( + String + ) +
+
+ The default behavior of this method is to call + ExternalContext#getResourceAsStream(String) on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4879 + + Set + + jakarta.faces.context.ExternalContextWrapper.getResourcePaths +
+ ( + String + ) +
+
+ The default behavior of this method is to call ExternalContext#getResourcePaths(String) + on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4880 + + Object + + jakarta.faces.context.ExternalContextWrapper.getResponse +
+
+
+ The default behavior of this method is to call ExternalContext#getResponse on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4881 + + int + + jakarta.faces.context.ExternalContextWrapper.getResponseBufferSize +
+
+
+ The default behavior of this method is to call ExternalContext#getResponseBufferSize() + on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4882 + + String + + jakarta.faces.context.ExternalContextWrapper.getResponseCharacterEncoding +
+
+
+ The default behavior of this method is to call + ExternalContext#getResponseCharacterEncoding on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4883 + + String + + jakarta.faces.context.ExternalContextWrapper.getResponseContentType +
+
+
+ The default behavior of this method is to call ExternalContext#getResponseContentType + on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4884 + + OutputStream + + jakarta.faces.context.ExternalContextWrapper.getResponseOutputStream +
+
+
+ The default behavior of this method is to call ExternalContext#getResponseOutputStream + on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4885 + + OutputStream + + jakarta.faces.context.ExternalContextWrapper.getResponseOutputStream +
+
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4886 + + Writer + + jakarta.faces.context.ExternalContextWrapper.getResponseOutputWriter +
+
+
+ The default behavior of this method is to call ExternalContext#getResponseOutputWriter + on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4887 + + Writer + + jakarta.faces.context.ExternalContextWrapper.getResponseOutputWriter +
+
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4888 + + Object + + jakarta.faces.context.ExternalContextWrapper.getSession +
+ ( + boolean + ) +
+
+ The default behavior of this method is to call ExternalContext#getSession(boolean) on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4889 + + String + + jakarta.faces.context.ExternalContextWrapper.getSessionId +
+ ( + boolean + ) +
+
+ The default behavior of this method is to call ExternalContext#getSessionId(boolean) on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4890 + + Map + + jakarta.faces.context.ExternalContextWrapper.getSessionMap +
+
+
+ The default behavior of this method is to call ExternalContext#getSessionMap() on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4891 + + int + + jakarta.faces.context.ExternalContextWrapper.getSessionMaxInactiveInterval +
+
+
+ The default behavior of this method is to call + ExternalContext#getSessionMaxInactiveInterval() on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4892 + + Principal + + jakarta.faces.context.ExternalContextWrapper.getUserPrincipal +
+
+
+ The default behavior of this method is to call ExternalContext#getUserPrincipal on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4893 + + ExternalContext + + jakarta.faces.context.ExternalContextWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4894 + + void + + jakarta.faces.context.ExternalContextWrapper.invalidateSession +
+
+
+ The default behavior of this method is to call ExternalContext#invalidateSession on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4895 + + boolean + + jakarta.faces.context.ExternalContextWrapper.isResponseCommitted +
+
+
+ The default behavior of this method is to call ExternalContext#isResponseCommitted() on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4896 + + boolean + + jakarta.faces.context.ExternalContextWrapper.isSecure +
+
+
+ The default behavior of this method is to call ExternalContext#isSecure on the wrapped + ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4897 + + boolean + + jakarta.faces.context.ExternalContextWrapper.isUserInRole +
+ ( + String + ) +
+
+ The default behavior of this method is to call ExternalContext#isUserInRole(String) on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4898 + + void + + jakarta.faces.context.ExternalContextWrapper.log +
+ ( + String + ) +
+
+ The default behavior of this method is to call ExternalContext#log(String) on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4899 + + void + + jakarta.faces.context.ExternalContextWrapper.log +
+ ( + String + , +
+ Throwable + ) +
+
+ The default behavior of this method is to call ExternalContext#log(String, Throwable) + on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4900 + + void + + jakarta.faces.context.ExternalContextWrapper.redirect +
+ ( + String + ) +
+
+ The default behavior of this method is to call ExternalContext#redirect(String) on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4901 + + void + + jakarta.faces.context.ExternalContextWrapper.redirect +
+ ( + String + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4902 + + void + + jakarta.faces.context.ExternalContextWrapper.release +
+
+
+ The default behavior of this method is to call ExternalContext#release() on the wrapped + ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4903 + + void + + jakarta.faces.context.ExternalContextWrapper.responseFlushBuffer +
+
+
+ The default behavior of this method is to call + jakarta.faces.context.ExternalContext#responseFlushBuffer() on the wrapped ExternalContext object. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4904 + + void + + jakarta.faces.context.ExternalContextWrapper.responseFlushBuffer +
+
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4905 + + void + + jakarta.faces.context.ExternalContextWrapper.responseReset +
+
+
+ The default behavior of this method is to call ExternalContext#responseReset() on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4906 + + void + + jakarta.faces.context.ExternalContextWrapper.responseSendError +
+ ( + int + , +
+ String + ) +
+
+ The default behavior of this method is to call + ExternalContext#responseSendError(int,String) on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4907 + + void + + jakarta.faces.context.ExternalContextWrapper.responseSendError +
+ ( + int + , +
+ String + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4908 + + void + + jakarta.faces.context.ExternalContextWrapper.setClientWindow +
+ ( + ClientWindow + ) +
+
+ The default behavior of this method is to call ExternalContext#setClientWindow on the + wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4909 + + void + + jakarta.faces.context.ExternalContextWrapper.setRequest +
+ ( + Object + ) +
+
+ The default behavior of this method is to call ExternalContext#setRequest(Object) on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4910 + + void + + jakarta.faces.context.ExternalContextWrapper.setRequestCharacterEncoding +
+ ( + String + ) +
+
+ The default behavior of this method is to call + ExternalContext#setRequestCharacterEncoding(String) on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4911 + + void + + jakarta.faces.context.ExternalContextWrapper.setRequestCharacterEncoding +
+ ( + String + ) + +
+ throws + UnsupportedEncodingException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:4912 + + void + + jakarta.faces.context.ExternalContextWrapper.setResponse +
+ ( + Object + ) +
+
+ The default behavior of this method is to call ExternalContext#setResponse(Object) on + the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4913 + + void + + jakarta.faces.context.ExternalContextWrapper.setResponseBufferSize +
+ ( + int + ) +
+
+ The default behavior of this method is to call + ExternalContext#setResponseBufferSize(int) on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4914 + + void + + jakarta.faces.context.ExternalContextWrapper.setResponseCharacterEncoding +
+ ( + String + ) +
+
+ The default behavior of this method is to call + ExternalContext#getResponseCharacterEncoding on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4915 + + void + + jakarta.faces.context.ExternalContextWrapper.setResponseContentLength +
+ ( + int + ) +
+
+ The default behavior of this method is to call + jakarta.faces.context.ExternalContext#setResponseContentLength(int) on the wrapped ExternalContext + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4916 + + void + + jakarta.faces.context.ExternalContextWrapper.setResponseContentType +
+ ( + String + ) +
+
+ The default behavior of this method is to call + ExternalContext#setResponseContentType(String) on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4917 + + void + + jakarta.faces.context.ExternalContextWrapper.setResponseHeader +
+ ( + String + , +
+ String + ) +
+
+ The default behavior of this method is to call + ExternalContext#setResponseHeader(String,String) on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4918 + + void + + jakarta.faces.context.ExternalContextWrapper.setResponseStatus +
+ ( + int + ) +
+
+ The default behavior of this method is to call ExternalContext#setResponseStatus(int) + on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4919 + + void + + jakarta.faces.context.ExternalContextWrapper.setSessionMaxInactiveInterval +
+ ( + int + ) +
+
+ The default behavior of this method is to call + ExternalContext#setSessionMaxInactiveInterval(int) on the wrapped ExternalContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4920 + + void + + jakarta.faces.context.FacesContext.addMessage +
+ ( + String + , +
+ FacesMessage + ) +
+
+ Append a jakarta.faces.application.FacesMessage to the set of messages associated with + the specified client identifier, if clientId is not null. If clientId is null, this + jakarta.faces.application.FacesMessage is assumed to not be associated with any specific component + instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4921 + + Application + + jakarta.faces.context.FacesContext.getApplication +
+
+
+ Return the Application instance associated with this web application. It is valid to + call this method during application startup or shutdown. If called during application startup or + shutdown, returns the correct current jakarta.faces.application.Application instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4922 + + Map + + jakarta.faces.context.FacesContext.getAttributes +
+
+
+ Return a mutable Map representing the attributes associated wth this FacesContext + instance. This Map is useful to store attributes that you want to go out of scope when the Faces + lifecycle for the current request ends, which is not always the same as the request ending, + especially in the case of Jakarta Servlet filters that are invoked after the Faces lifecycle for + this request completes. Accessing this Map does not cause any events to fire, as is the case with + the other maps: for request, session, and application scope. When #release() is invoked, the + attributes must be cleared. The Map returned by this method is not associated with the request. If + you would like to get or set request attributes, see ExternalContext#getRequestMap. The default + implementation throws UnsupportedOperationException and is provided for the sole purpose of not + breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4923 + + Iterator + + jakarta.faces.context.FacesContext.getClientIdsWithMessages +
+
+
+ Return an Iterator over the client identifiers for which at least one + jakarta.faces.application.FacesMessage has been queued. If there are no such client identifiers, an + empty Iterator is returned. If any messages have been queued that were not associated with any + specific client identifier, a null value will be included in the iterated values. The elements in + the Iterator must be returned in the order in which they were added with #addMessage. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4924 + + PhaseId + + jakarta.faces.context.FacesContext.getCurrentPhaseId +
+
+
+ Return the value last set on this FacesContext instance when #setCurrentPhaseId was + called. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4925 + + ELContext + + jakarta.faces.context.FacesContext.getELContext +
+
+
+ Return the ELContext instance for this FacesContext instance. This ELContext instance + has the same lifetime and scope as the FacesContext instance with which it is associated, and may be + created lazily the first time this method is called for a given FacesContext instance. Upon creation + of the ELContext instance, the implementation must take the following action: Call the + ELContext#putContext method on the instance, passing in FacesContext.class and the this reference + for the FacesContext instance itself. If the Collection returned by + jakarta.faces.application.Application#getELContextListeners is non-empty, create an instance of + jakarta.el.ELContextEvent and pass it to each jakarta.el.ELContextListener instance in the + Collection by calling the jakarta.el.ELContextListener#contextCreated method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4926 + + ExceptionHandler + + jakarta.faces.context.FacesContext.getExceptionHandler +
+
+
+ Return the ExceptionHandler for this request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4927 + + ExternalContext + + jakarta.faces.context.FacesContext.getExternalContext +
+
+
+ Return the ExternalContext instance for this FacesContext instance. It is valid to call + this method during application startup or shutdown. If called during application startup or + shutdown, this method returns an ExternalContext instance with the special behaviors indicated in + the javadoc for that class. Methods document as being valid to call during application startup or + shutdown must be supported. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4928 + + Lifecycle + + jakarta.faces.context.FacesContext.getLifecycle +
+
+
+ Return the Lifecycle instance for this FacesContext instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4929 + + Severity + + jakarta.faces.context.FacesContext.getMaximumSeverity +
+
+
+ Return the maximum severity level recorded on any + jakarta.faces.application.FacesMessages that has been queued, whether or not they are associated + with any specific jakarta.faces.component.UIComponent. If no such messages have been queued, return + null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4930 + + List + + jakarta.faces.context.FacesContext.getMessageList +
+
+
+ Like #getMessages, but returns a List, enabling use from Jakarta Expression Language + expressions. The default implementation throws UnsupportedOperationException and is provided for the + sole purpose of not breaking existing applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4931 + + List + + jakarta.faces.context.FacesContext.getMessageList +
+ ( + String + ) +
+
+ Like #getMessages(java.lang.String), but returns a List of messages for the component + with client id matching argument clientId. The default implementation throws + UnsupportedOperationException and is provided for the sole purpose of not breaking existing + applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4932 + + Iterator + + jakarta.faces.context.FacesContext.getMessages +
+ ( + String + ) +
+
+ Return an Iterator over the jakarta.faces.application.FacesMessages that have been + queued that are associated with the specified client identifier (if clientId is not null), or over + the jakarta.faces.application.FacesMessages that have been queued that are not associated with any + specific client identifier (if clientId is null). If no such messages have been queued, return an + empty Iterator. The elements of the Iterator must be returned in the order in which they were added + with calls to #addMessage. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4933 + + char + + jakarta.faces.context.FacesContext.getNamingContainerSeparatorChar +
+
+
+ Return the result of calling UINamingContainer#getSeparatorChar, passing this as the + argument. Note that this enables accessing the value of this property from the Jakarta Expression + Language expression #{facesContext.namingContainerSeparatorChar}. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4934 + + PartialViewContext + + jakarta.faces.context.FacesContext.getPartialViewContext +
+
+
+ Return the PartialViewContext for this request. The PartialViewContext is used to + control the processing of specified components during the execute portion of the request processing + lifecycle (known as partial processing) and the rendering of specified components (known as partial + rendering). This method must return a new PartialViewContext if one does not already exist. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4935 + + RenderKit + + jakarta.faces.context.FacesContext.getRenderKit +
+
+
+ Return the RenderKit instance for the render kit identifier specified on our + UIViewRoot, if there is one. If there is no current UIViewRoot, if the UIViewRoot does not have a + specified renderKitId, or if there is no RenderKit for the specified identifier, return null + instead. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4936 + + boolean + + jakarta.faces.context.FacesContext.getRenderResponse +
+
+
+ Return true if the renderResponse() method has been called for the current request. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4937 + + List + + jakarta.faces.context.FacesContext.getResourceLibraryContracts +
+
+
+ Return the list of resource library contracts that have been calculated to be + appropriate for use with this view, or an empty list if there are no such resource library + contracts. The list returned by this method must be immutable. For backward compatibility with + implementations of the specification prior to when this method was introduced, an implementation is + provided that returns an empty list. Implementations compliant with the version in which this method + was introduced must implement this method as specified. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4938 + + boolean + + jakarta.faces.context.FacesContext.getResponseComplete +
+
+
+ Return true if the responseComplete() method has been called for the current request. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4939 + + UIViewRoot + + jakarta.faces.context.FacesContext.getViewRoot +
+
+
+ Return the root component that is associated with the this request. It is valid to call + this method during application startup or shutdown. If called during application startup or + shutdown, this method returns a new UIViewRoot with its locale set to Locale.getDefault(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4940 + + boolean + + jakarta.faces.context.FacesContext.isPostback +
+
+
+ This utility method simply returns the result of + jakarta.faces.render.ResponseStateManager#isPostback(FacesContext). The default implementation + throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing + applications that extend this class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4941 + + boolean + + jakarta.faces.context.FacesContext.isProcessingEvents +
+
+
+ Returns a flag indicating whether or not the runtime should publish events when asked + to do so. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4942 + + boolean + + jakarta.faces.context.FacesContext.isProjectStage +
+ ( + ProjectStage + ) +
+
+ Return true if the current ProjectStage as returned by the Application instance is + equal to stage, otherwise return false + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4943 + + boolean + + jakarta.faces.context.FacesContext.isReleased +
+
+
+ Return a flag indicating if the resources associated with this FacesContext instance + have been released. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4944 + + boolean + + jakarta.faces.context.FacesContext.isValidationFailed +
+
+
+ Return true if the validationFailed() method has been called for the current request. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4945 + + void + + jakarta.faces.context.FacesContext.setCurrentPhaseId +
+ ( + PhaseId + ) +
+
+ The implementation must call this method at the earliest possble point in time after + entering into a new phase in the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4946 + + void + + jakarta.faces.context.FacesContext.setExceptionHandler +
+ ( + ExceptionHandler + ) +
+
+ Set the ExceptionHandler for this request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4947 + + void + + jakarta.faces.context.FacesContext.setProcessingEvents +
+ ( + boolean + ) +
+
+ Allows control of wheter or not the runtime will publish events when + Application#publishEvent(FacesContext, Class, Object) or Application#publishEvent(FacesContext, + Class, Class, Object) is called. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4948 + + void + + jakarta.faces.context.FacesContext.setResourceLibraryContracts +
+ ( + List + ) +
+
+ Set the resource library contracts calculated as valid to use with this view. The + implementation must copy the contents of the incoming List into an immutable List for return from + #getResourceLibraryContracts. If the argument is null or empty, the action taken is the same as if + the argument is null: a subsequent call to getResourceLibraryContracts returns null. This method may + only be called during the processing of jakarta.faces.view.ViewDeclarationLanguage#createView and + during the VDL tag handler for the tag corresponding to an instance of UIViewRoot. For backward + compatibility with implementations of the specification prior to when this method was introduced, an + implementation is provided that takes no action. Implementations compliant with the version in which + this method was introduced must implement this method as specified. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4949 + + void + + jakarta.faces.context.FacesContext.setViewRoot +
+ ( + UIViewRoot + ) +
+
+ Set the root component that is associated with this request. This method can be called + by the application handler (or a class that the handler calls), during the Invoke Application phase + of the request processing lifecycle and during the Restore View phase of the request processing + lifecycle (especially when a new root component is created). In the present version of the + specification, implementations are not required to enforce this restriction, though a future version + of the specification may require enforcement. If the current UIViewRoot is non-null, and calling + equals() on the argument root, passing the current UIViewRoot returns false, the clear method must + be called on the Map returned from UIViewRoot#getViewMap. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4950 + + void + + jakarta.faces.context.FacesContext.validationFailed +
+
+
+ Sets a flag which indicates that a conversion or validation error occurred while + processing the inputs. Inputs consist of either page parameters or form bindings. This flag can be + read using #isValidationFailed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4951 + + FacesContextFactory + + jakarta.faces.context.FacesContextFactory.FacesContextFactory +
+ ( + FacesContextFactory + ) +
+
+ If this factory has been decorated, the implementation doing the decorating should push + the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4952 + + FacesContext + + jakarta.faces.context.FacesContextFactory.getFacesContext +
+ ( + Object + , +
+ Object + , +
+ Object + , +
+ Lifecycle + ) +
+
+ Create (if needed) and return a FacesContext instance that is initialized for the + processing of the specified request and response objects, utilizing the specified Lifecycle + instance, for this web application. The implementation of this method must ensure that calls to the + getCurrentInstance() method of FacesContext, from the same thread that called this method, will + return the same FacesContext instance until the release() method is called on that instance. The + implementation must call ExternalContextFactory#getExternalContext to produce the ExternalContext + for the FacesContext instance. The default implementation must call + ExceptionHandlerFactory#getExceptionHandler and make it so the return from that method is what gets + returned from a call to FacesContext#getExceptionHandler on the returned FacesContext instance. The + default implementation must call jakarta.faces.lifecycle.ClientWindowFactory#getClientWindow and + make it so the return from that method is what gets returned from a call to + ExternalContext#getClientWindow() on the returned ExternalContext instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4953 + + FacesContext + + jakarta.faces.context.FacesContextFactory.getFacesContext +
+ ( + Object + , +
+ Object + , +
+ Object + , +
+ Lifecycle + ) + +
+ throws + FacesException +
+
+
+ if a FacesContext cannot be constructed for the specified parameters + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4954 + + FacesContextFactory + + jakarta.faces.context.FacesContextFactory.getWrapped +
+
+
+ If this factory has been decorated, the implementation doing the decorating may + override this method to provide access to the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4955 + + void + + jakarta.faces.context.FacesContextWrapper.addMessage +
+ ( + String + , +
+ FacesMessage + ) +
+
+ The default behavior of this method is to call FacesContext#addMessage(String, + FacesMessage) on the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4956 + + FacesContextWrapper + + jakarta.faces.context.FacesContextWrapper.FacesContextWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:4957 + + FacesContextWrapper + + jakarta.faces.context.FacesContextWrapper.FacesContextWrapper +
+ ( + FacesContext + ) +
+
+ If this faces context has been decorated, the implementation doing the decorating + should push the implementation being wrapped to this constructor. The #getWrapped() will then return + the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4958 + + Application + + jakarta.faces.context.FacesContextWrapper.getApplication +
+
+
+ The default behavior of this method is to call FacesContext#getApplication() on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4959 + + Map + + jakarta.faces.context.FacesContextWrapper.getAttributes +
+
+
+ The default behavior of this method is to call FacesContext#getAttributes() on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4960 + + Iterator + + jakarta.faces.context.FacesContextWrapper.getClientIdsWithMessages +
+
+
+ The default behavior of this method is to call + jakarta.faces.context.FacesContext#getClientIdsWithMessages() on the wrapped FacesContext object. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4961 + + PhaseId + + jakarta.faces.context.FacesContextWrapper.getCurrentPhaseId +
+
+
+ The default behavior of this method is to call FacesContext#getCurrentPhaseId() on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4962 + + ELContext + + jakarta.faces.context.FacesContextWrapper.getELContext +
+
+
+ The default behavior of this method is to call FacesContext#getELContext() on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4963 + + ExceptionHandler + + jakarta.faces.context.FacesContextWrapper.getExceptionHandler +
+
+
+ The default behavior of this method is to call FacesContext#getExceptionHandler() on + the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4964 + + ExternalContext + + jakarta.faces.context.FacesContextWrapper.getExternalContext +
+
+
+ The default behavior of this method is to call FacesContext#getExternalContext() on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4965 + + Lifecycle + + jakarta.faces.context.FacesContextWrapper.getLifecycle +
+
+
+ The default behavior of this method is to call FacesContext#getLifecycle() on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4966 + + Severity + + jakarta.faces.context.FacesContextWrapper.getMaximumSeverity +
+
+
+ The default behavior of this method is to call FacesContext#getMaximumSeverity() on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4967 + + List + + jakarta.faces.context.FacesContextWrapper.getMessageList +
+
+
+ The default behavior of this method is to call FacesContext#getMessageList() on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4968 + + List + + jakarta.faces.context.FacesContextWrapper.getMessageList +
+ ( + String + ) +
+
+ The default behavior of this method is to call FacesContext#getMessageList(String) on + the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4969 + + Iterator + + jakarta.faces.context.FacesContextWrapper.getMessages +
+
+
+ The default behavior of this method is to call FacesContext#getMessages() on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4970 + + Iterator + + jakarta.faces.context.FacesContextWrapper.getMessages +
+ ( + String + ) +
+
+ The default behavior of this method is to call FacesContext#getMessages(String) on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4971 + + char + + jakarta.faces.context.FacesContextWrapper.getNamingContainerSeparatorChar +
+
+
+ The default behavior of this method is to call + FacesContext#getNamingContainerSeparatorChar() on the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4972 + + PartialViewContext + + jakarta.faces.context.FacesContextWrapper.getPartialViewContext +
+
+
+ The default behavior of this method is to call FacesContext#getPartialViewContext() ()} + on the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4973 + + RenderKit + + jakarta.faces.context.FacesContextWrapper.getRenderKit +
+
+
+ The default behavior of this method is to call FacesContext#getRenderKit() on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4974 + + boolean + + jakarta.faces.context.FacesContextWrapper.getRenderResponse +
+
+
+ The default behavior of this method is to call FacesContext#getRenderResponse() on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4975 + + List + + jakarta.faces.context.FacesContextWrapper.getResourceLibraryContracts +
+
+
+ The default behavior of this method is to call FacesContext#getResourceLibraryContracts + on the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4976 + + boolean + + jakarta.faces.context.FacesContextWrapper.getResponseComplete +
+
+
+ The default behavior of this method is to call FacesContext#getResponseComplete() on + the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4977 + + ResponseStream + + jakarta.faces.context.FacesContextWrapper.getResponseStream +
+
+
+ The default behavior of this method is to call FacesContext#getResponseStream() on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4978 + + ResponseWriter + + jakarta.faces.context.FacesContextWrapper.getResponseWriter +
+
+
+ The default behavior of this method is to call FacesContext#getResponseWriter() on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4979 + + UIViewRoot + + jakarta.faces.context.FacesContextWrapper.getViewRoot +
+
+
+ The default behavior of this method is to call FacesContext#getViewRoot() on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4980 + + FacesContext + + jakarta.faces.context.FacesContextWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4981 + + boolean + + jakarta.faces.context.FacesContextWrapper.isPostback +
+
+
+ The default behavior of this method is to call FacesContext#isPostback() on the wrapped + FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4982 + + boolean + + jakarta.faces.context.FacesContextWrapper.isProcessingEvents +
+
+
+ The default behavior of this method is to call + jakarta.faces.context.FacesContext#isProcessingEvents() on the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4983 + + boolean + + jakarta.faces.context.FacesContextWrapper.isProjectStage +
+ ( + ProjectStage + ) +
+
+ The default behavior of this method is to call + jakarta.faces.context.FacesContext#isProjectStage(jakarta.faces.application.ProjectStage) on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4984 + + boolean + + jakarta.faces.context.FacesContextWrapper.isReleased +
+
+
+ The default behavior of this method is to call FacesContext#isReleased on the wrapped + FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4985 + + boolean + + jakarta.faces.context.FacesContextWrapper.isValidationFailed +
+
+
+ The default behavior of this method is to call + jakarta.faces.context.FacesContext#isValidationFailed on the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4986 + + void + + jakarta.faces.context.FacesContextWrapper.release +
+
+
+ The default behavior of this method is to call FacesContext#release() on the wrapped + FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4987 + + void + + jakarta.faces.context.FacesContextWrapper.renderResponse +
+
+
+ The default behavior of this method is to call FacesContext#renderResponse() on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4988 + + void + + jakarta.faces.context.FacesContextWrapper.responseComplete +
+
+
+ The default behavior of this method is to call FacesContext#responseComplete() on the + wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4989 + + void + + jakarta.faces.context.FacesContextWrapper.setCurrentPhaseId +
+ ( + PhaseId + ) +
+
+ The default behavior of this method is to call FacesContext#setCurrentPhaseId(PhaseId) + on the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4990 + + void + + jakarta.faces.context.FacesContextWrapper.setExceptionHandler +
+ ( + ExceptionHandler + ) +
+
+ The default behavior of this method is to call + FacesContext#setExceptionHandler(ExceptionHandler) on the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4991 + + void + + jakarta.faces.context.FacesContextWrapper.setProcessingEvents +
+ ( + boolean + ) +
+
+ The default behavior of this method is to call + FacesContext#setProcessingEvents(boolean) on the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4992 + + void + + jakarta.faces.context.FacesContextWrapper.setResourceLibraryContracts +
+ ( + List + ) +
+
+ The default behavior of this method is to call FacesContext#setResourceLibraryContracts + on the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4993 + + void + + jakarta.faces.context.FacesContextWrapper.setResponseStream +
+ ( + ResponseStream + ) +
+
+ The default behavior of this method is to call + FacesContext#setResponseStream(ResponseStream) on the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4994 + + void + + jakarta.faces.context.FacesContextWrapper.setResponseWriter +
+ ( + ResponseWriter + ) +
+
+ The default behavior of this method is to call + FacesContext#setResponseWriter(ResponseWriter) on the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4995 + + void + + jakarta.faces.context.FacesContextWrapper.setViewRoot +
+ ( + UIViewRoot + ) +
+
+ The default behavior of this method is to call FacesContext#setViewRoot(UIViewRoot) on + the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4996 + + void + + jakarta.faces.context.FacesContextWrapper.validationFailed +
+
+
+ The default behavior of this method is to call + jakarta.faces.context.FacesContext#validationFailed() on the wrapped FacesContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4997 + + void + + jakarta.faces.context.Flash.doPostPhaseActions +
+ ( + FacesContext + ) +
+
+ Called after the execution of every lifecycle phase, this method allows implementations + to take the necessary actions to provide the Flash scope contract as it applies to the request + procesing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4998 + + void + + jakarta.faces.context.Flash.doPrePhaseActions +
+ ( + FacesContext + ) +
+
+ Called before the execution of every lifecycle phase, this method allows + implementations to take the necessary actions to provide the Flash scope contract as it applies to + the request procesing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:4999 + + Flash + + jakarta.faces.context.Flash.Flash +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5000 + + boolean + + jakarta.faces.context.Flash.isKeepMessages +
+
+
+ Return the value of this JavaBeans property for the flash for this session. This value + determines whether or not any jakarta.faces.application.FacesMessage instances queued in the current + jakarta.faces.context.FacesContext must be preserved so they are accessible on the next traversal of + the lifecycle on this session, regardless of the request being a redirect after post, or a normal + postback. Map accesses for the special key #8220;keepMessages #8221; must return the value of this + JavaBeans property. Jakarta Expression Language Usage Example First page Next page Any messages + present on the first page must be displayed on this page. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5001 + + boolean + + jakarta.faces.context.Flash.isRedirect +
+
+
+ Return the value of this property for the flash for this session. This must be false + unless: #setRedirect was called for the current lifecycle traversal with true as the argument. The + current lifecycle traversal for this session is in the #8220;execute #8221; phase and the previous + traversal had #setRedirect called with true as the argument. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5002 + + void + + jakarta.faces.context.Flash.keep +
+ ( + String + ) +
+
+ Causes a value stored with a previous call to #putNow, its Jakarta Expression Language + equivalent, or to the request Map, to be promoted to the flash so that is available on the next + traversal through the lifecycle on this session. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5003 + + void + + jakarta.faces.context.Flash.putNow +
+ ( + String + , +
+ Object + ) +
+
+ Puts a value in the flash so that it can be accessed on this traversal of the + lifecycle, rather than on the next traversal. This is simply an alias for putting a value in the + request map. Jakarta Expression Language Usage Example Value of \#{flash.now.bar}, should be + barValue. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5004 + + void + + jakarta.faces.context.Flash.setKeepMessages +
+ ( + boolean + ) +
+
+ Setter for keepMessages JavaBeans property. See #isKeepMessages. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5005 + + void + + jakarta.faces.context.Flash.setRedirect +
+ ( + boolean + ) +
+
+ Setting this property to true indicates that the next request on this session will be a + redirect. Recall that on a redirect, the server sends a special response to the client instructing + it to issue a new request to a specific URI. The implementation must insure that reading the value + of this property on that request will return true. Jakarta Expression Language Usage Example + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5006 + + FlashFactory + + jakarta.faces.context.FlashFactory.FlashFactory +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:5007 + + FlashFactory + + jakarta.faces.context.FlashFactory.FlashFactory +
+ ( + FlashFactory + ) +
+
+ If this factory has been decorated, the implementation doing the decorating should push + the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5008 + + Flash + + jakarta.faces.context.FlashFactory.getFlash +
+ ( + boolean + ) +
+
+ Create (if needed) and return a Flash instance for this web application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5009 + + FlashFactory + + jakarta.faces.context.FlashFactory.getWrapped +
+
+
+ If this factory has been decorated, the implementation doing the decorating may + override this method to provide access to the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5010 + + void + + jakarta.faces.context.FlashWrapper.clear +
+
+
+ The default behavior of this method is to call Flash#clear() on the wrapped Flash + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5011 + + boolean + + jakarta.faces.context.FlashWrapper.containsKey +
+ ( + Object + ) +
+
+ The default behavior of this method is to call Flash#containsKey(Object) on the wrapped + Flash object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5012 + + boolean + + jakarta.faces.context.FlashWrapper.containsValue +
+ ( + Object + ) +
+
+ The default behavior of this method is to call Flash#containsValue(Object) on the + wrapped Flash object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5013 + + void + + jakarta.faces.context.FlashWrapper.doPostPhaseActions +
+ ( + FacesContext + ) +
+
+ The default behavior of this method is to call Flash#doPostPhaseActions(FacesContext) + on the wrapped Flash object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5014 + + void + + jakarta.faces.context.FlashWrapper.doPrePhaseActions +
+ ( + FacesContext + ) +
+
+ The default behavior of this method is to call Flash#doPrePhaseActions(FacesContext) on + the wrapped Flash object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5015 + + Set + + jakarta.faces.context.FlashWrapper.entrySet +
+
+
+ The default behavior of this method is to call Flash#entrySet() on the wrapped Flash + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5016 + + FlashWrapper + + jakarta.faces.context.FlashWrapper.FlashWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:5017 + + FlashWrapper + + jakarta.faces.context.FlashWrapper.FlashWrapper +
+ ( + Flash + ) +
+
+ If this flash has been decorated, the implementation doing the decorating should push + the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5018 + + Object + + jakarta.faces.context.FlashWrapper.get +
+ ( + Object + ) +
+
+ The default behavior of this method is to call Flash#get(Object) on the wrapped Flash + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5019 + + Flash + + jakarta.faces.context.FlashWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5020 + + boolean + + jakarta.faces.context.FlashWrapper.isEmpty +
+
+
+ The default behavior of this method is to call Flash#isEmpty() on the wrapped Flash + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5021 + + boolean + + jakarta.faces.context.FlashWrapper.isKeepMessages +
+
+
+ The default behavior of this method is to call Flash#isKeepMessages() on the wrapped + Flash object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5022 + + boolean + + jakarta.faces.context.FlashWrapper.isRedirect +
+
+
+ The default behavior of this method is to call Flash#isRedirect() on the wrapped Flash + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5023 + + void + + jakarta.faces.context.FlashWrapper.keep +
+ ( + String + ) +
+
+ The default behavior of this method is to call Flash#keep(String) on the wrapped Flash + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5024 + + Set + + jakarta.faces.context.FlashWrapper.keySet +
+
+
+ The default behavior of this method is to call Flash#keySet() on the wrapped Flash + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5025 + + Object + + jakarta.faces.context.FlashWrapper.put +
+ ( + String + , +
+ Object + ) +
+
+ The default behavior of this method is to call Flash#put on the wrapped Flash object. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5026 + + void + + jakarta.faces.context.FlashWrapper.putAll +
+ ( + Map + ) +
+
+ The default behavior of this method is to call Flash#putAll(Map) on the wrapped Flash + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5027 + + void + + jakarta.faces.context.FlashWrapper.putNow +
+ ( + String + , +
+ Object + ) +
+
+ The default behavior of this method is to call Flash#putNow(String, Object) on the + wrapped Flash object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5028 + + Object + + jakarta.faces.context.FlashWrapper.remove +
+ ( + Object + ) +
+
+ The default behavior of this method is to call Flash#remove(Object) on the wrapped + Flash object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5029 + + void + + jakarta.faces.context.FlashWrapper.setKeepMessages +
+ ( + boolean + ) +
+
+ The default behavior of this method is to call Flash#setKeepMessages(boolean) on the + wrapped Flash object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5030 + + void + + jakarta.faces.context.FlashWrapper.setRedirect +
+ ( + boolean + ) +
+
+ The default behavior of this method is to call Flash#setRedirect(boolean) on the + wrapped Flash object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5031 + + int + + jakarta.faces.context.FlashWrapper.size +
+
+
+ The default behavior of this method is to call Flash#size() on the wrapped Flash + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5032 + + Collection + + jakarta.faces.context.FlashWrapper.values +
+
+
+ The default behavior of this method is to call Flash#values() on the wrapped Flash + object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5033 + + void + + jakarta.faces.context.PartialResponseWriter.delete +
+ ( + String + ) +
+
+ Write a delete operation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5034 + + void + + jakarta.faces.context.PartialResponseWriter.delete +
+ ( + String + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5035 + + void + + jakarta.faces.context.PartialResponseWriter.endDocument +
+
+
+ Write the end of a partial response. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5036 + + void + + jakarta.faces.context.PartialResponseWriter.endDocument +
+
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5037 + + void + + jakarta.faces.context.PartialResponseWriter.endError +
+
+
+ Write the end of an error. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5038 + + void + + jakarta.faces.context.PartialResponseWriter.endError +
+
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5039 + + void + + jakarta.faces.context.PartialResponseWriter.endEval +
+
+
+ Write the end of an eval operation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5040 + + void + + jakarta.faces.context.PartialResponseWriter.endEval +
+
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5041 + + void + + jakarta.faces.context.PartialResponseWriter.endExtension +
+
+
+ Write the end of an extension operation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5042 + + void + + jakarta.faces.context.PartialResponseWriter.endExtension +
+
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5043 + + void + + jakarta.faces.context.PartialResponseWriter.endInsert +
+
+
+ Write the end of an insert operation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5044 + + void + + jakarta.faces.context.PartialResponseWriter.endInsert +
+
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5045 + + void + + jakarta.faces.context.PartialResponseWriter.endUpdate +
+
+
+ Write the end of an update operation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5046 + + void + + jakarta.faces.context.PartialResponseWriter.endUpdate +
+
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5047 + + PartialResponseWriter + + jakarta.faces.context.PartialResponseWriter.PartialResponseWriter +
+ ( + ResponseWriter + ) +
+
+ Create a PartialResponseWriter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5048 + + void + + jakarta.faces.context.PartialResponseWriter.redirect +
+ ( + String + ) +
+
+ Write a redirect operation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5049 + + void + + jakarta.faces.context.PartialResponseWriter.redirect +
+ ( + String + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5050 + + void + + jakarta.faces.context.PartialResponseWriter.startDocument +
+
+
+ Write the start of a partial response. If UIViewRoot is an instance of NamingContainer, + then write UIViewRoot#getContainerClientId(FacesContext) as value of the id attribute of the root + element. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5051 + + void + + jakarta.faces.context.PartialResponseWriter.startDocument +
+
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5052 + + void + + jakarta.faces.context.PartialResponseWriter.startError +
+ ( + String + ) +
+
+ Write the start of an error. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5053 + + void + + jakarta.faces.context.PartialResponseWriter.startError +
+ ( + String + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5054 + + void + + jakarta.faces.context.PartialResponseWriter.startEval +
+
+
+ Write the start of an eval operation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5055 + + void + + jakarta.faces.context.PartialResponseWriter.startEval +
+
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5056 + + void + + jakarta.faces.context.PartialResponseWriter.startExtension +
+ ( + Map + ) +
+
+ Write the start of an extension operation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5057 + + void + + jakarta.faces.context.PartialResponseWriter.startExtension +
+ ( + Map + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5058 + + void + + jakarta.faces.context.PartialResponseWriter.startInsertAfter +
+ ( + String + ) +
+
+ Write the start of an insert operation where the contents will be inserted after the + specified target node. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5059 + + void + + jakarta.faces.context.PartialResponseWriter.startInsertAfter +
+ ( + String + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5060 + + void + + jakarta.faces.context.PartialResponseWriter.startInsertBefore +
+ ( + String + ) +
+
+ Write the start of an insert operation where the contents will be inserted before the + specified target node. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5061 + + void + + jakarta.faces.context.PartialResponseWriter.startInsertBefore +
+ ( + String + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5062 + + void + + jakarta.faces.context.PartialResponseWriter.startUpdate +
+ ( + String + ) +
+
+ Write the start of an update operation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5063 + + void + + jakarta.faces.context.PartialResponseWriter.startUpdate +
+ ( + String + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5064 + + void + + jakarta.faces.context.PartialResponseWriter.updateAttributes +
+ ( + String + , +
+ Map + ) +
+
+ Write an attribute update operation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5065 + + void + + jakarta.faces.context.PartialResponseWriter.updateAttributes +
+ ( + String + , +
+ Map + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5066 + + List + + jakarta.faces.context.PartialViewContext.getEvalScripts +
+
+
+ Returns a mutable List of scripts to be evaluated in client side on complete of ajax + request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5067 + + Collection + + jakarta.faces.context.PartialViewContext.getExecuteIds +
+
+
+ Return a Collection of client identifiers from the current request with the request + parameter name #PARTIAL_EXECUTE_PARAM_NAME. If there is no such request parameter, return an empty + Collection. These client identifiers are used to identify components that will be processed during + the execute phase of the request processing lifecycle. The returned Collection is mutable. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5068 + + PartialResponseWriter + + jakarta.faces.context.PartialViewContext.getPartialResponseWriter +
+
+
+ Return the ResponseWriter to which components should direct their output for partial + view rendering. Within a given response, components can use either the ResponseStream or the + ResponseWriter, but not both. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5069 + + Collection + + jakarta.faces.context.PartialViewContext.getRenderIds +
+
+
+ Return a Collection of client identifiers from the current request with the request + parameter name #PARTIAL_RENDER_PARAM_NAME. If there is no such request parameter, return an empty + Collection. These client identifiers are used to identify components that will be processed during + the render phase of the request processing lifecycle. The returned Collection is mutable. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5070 + + boolean + + jakarta.faces.context.PartialViewContext.isAjaxRequest +
+
+
+ Return true if the request header Faces-Request is present with the value partial/ajax. + Otherwise, return false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5071 + + boolean + + jakarta.faces.context.PartialViewContext.isExecuteAll +
+
+
+ Return true if #isAjaxRequest returns true and #PARTIAL_EXECUTE_PARAM_NAME is present + in the current request with the value #ALL_PARTIAL_PHASE_CLIENT_IDS. Otherwise, return false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5072 + + boolean + + jakarta.faces.context.PartialViewContext.isPartialRequest +
+
+
+ Return true #isAjaxRequest returns true or if the request header Faces-Request is + present with the value partial/process. Otherwise, return false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5073 + + boolean + + jakarta.faces.context.PartialViewContext.isRenderAll +
+
+
+ Return true if #isAjaxRequest returns true and #PARTIAL_RENDER_PARAM_NAME is present in + the current request with the value #ALL_PARTIAL_PHASE_CLIENT_IDS. Otherwise, return false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5074 + + boolean + + jakarta.faces.context.PartialViewContext.isResetValues +
+
+
+ Return true if the incoming request has a parameter named by the value of + #RESET_VALUES_PARAM_NAME and that value is true. To preserve backward compatibility with custom + implementations that may have extended from an earlier version of this class, an implementation is + provided that returns false. A compliant implementation must override this method to take the + specified action. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5075 + + PartialViewContext + + jakarta.faces.context.PartialViewContext.PartialViewContext +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5076 + + void + + jakarta.faces.context.PartialViewContext.processPartial +
+ ( + PhaseId + ) +
+
+ Perform lifecycle processing on components during the indicated phaseId. Only those + components with identifiers existing in the Collection returned from #getExecuteIds and + #getRenderIds will be processed. When the indicated phaseId equals PhaseId#RENDER_RESPONSE, then + perform the following tasks in sequence: If #isResetValues() returns true, then call + UIViewRoot#resetValues(FacesContext, Collection), passing #getRenderIds(). If #isRenderAll() returns + false, then render any component resource of UIViewRoot whose + ResourceHandler#getRendererTypeForResourceName(String) does not return null, and whose + UIComponent#getChildCount() is zero, and whose ResourceHandler#isResourceRendered(FacesContext, + String, String) returns false, in an update element with an identifier of jakarta.faces.Resource. + Process the components. Obtain the state by calling StateManager#getViewState and write it out as an + update element with an identifier of jakarta.faces.ViewState where is the return from + UIViewRoot#getContainerClientId(FacesContext) on the view from whence this state originated, and is + the currently configured UINamingContainer#getSeparatorChar(FacesContext). If #isRenderAll() returns + false, then write out each script of #getEvalScripts() as an eval element. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5077 + + void + + jakarta.faces.context.PartialViewContext.release +
+
+
+ Release any resources associated with this PartialViewContext instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5078 + + void + + jakarta.faces.context.PartialViewContext.setPartialRequest +
+ ( + boolean + ) +
+
+ Dynamically indicate that this is a partial request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5079 + + void + + jakarta.faces.context.PartialViewContext.setRenderAll +
+ ( + boolean + ) +
+
+ Indicate the entire view must be rendered if renderAll is true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5080 + + PartialViewContext + + jakarta.faces.context.PartialViewContextFactory.getPartialViewContext +
+ ( + FacesContext + ) +
+
+ Create (if needed) and return a PartialViewContext instance that is initialized using + the current FacesContext instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5081 + + PartialViewContextFactory + + jakarta.faces.context.PartialViewContextFactory.getWrapped +
+
+
+ If this factory has been decorated, the implementation doing the decorating may + override this method to provide access to the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5082 + + PartialViewContextFactory + + jakarta.faces.context.PartialViewContextFactory.PartialViewContextFactory +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:5083 + + PartialViewContextFactory + + jakarta.faces.context.PartialViewContextFactory.PartialViewContextFactory +
+ ( + PartialViewContextFactory + ) +
+
+ If this factory has been decorated, the implementation doing the decorating should push + the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5084 + + List + + jakarta.faces.context.PartialViewContextWrapper.getEvalScripts +
+
+
+ The default behavior of this method is to call PartialViewContext#getRenderIds() on the + wrapped PartialViewContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5085 + + Collection + + jakarta.faces.context.PartialViewContextWrapper.getExecuteIds +
+
+
+ The default behavior of this method is to call PartialViewContext#getExecuteIds() on + the wrapped PartialViewContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5086 + + PartialResponseWriter + + jakarta.faces.context.PartialViewContextWrapper.getPartialResponseWriter +
+
+
+ The default behavior of this method is to call + PartialViewContext#getPartialResponseWriter() on the wrapped PartialViewContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5087 + + Collection + + jakarta.faces.context.PartialViewContextWrapper.getRenderIds +
+
+
+ The default behavior of this method is to call PartialViewContext#getRenderIds() on the + wrapped PartialViewContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5088 + + PartialViewContext + + jakarta.faces.context.PartialViewContextWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5089 + + boolean + + jakarta.faces.context.PartialViewContextWrapper.isAjaxRequest +
+
+
+ The default behavior of this method is to call PartialViewContext#isAjaxRequest() on + the wrapped PartialViewContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5090 + + boolean + + jakarta.faces.context.PartialViewContextWrapper.isExecuteAll +
+
+
+ The default behavior of this method is to call PartialViewContext#isExecuteAll() on the + wrapped PartialViewContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5091 + + boolean + + jakarta.faces.context.PartialViewContextWrapper.isPartialRequest +
+
+
+ The default behavior of this method is to call PartialViewContext#isPartialRequest() on + the wrapped PartialViewContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5092 + + boolean + + jakarta.faces.context.PartialViewContextWrapper.isRenderAll +
+
+
+ The default behavior of this method is to call PartialViewContext#isRenderAll() on the + wrapped PartialViewContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5093 + + boolean + + jakarta.faces.context.PartialViewContextWrapper.isResetValues +
+
+
+ The default behavior of this method is to call PartialViewContext#isResetValues() on + the wrapped PartialViewContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5094 + + PartialViewContextWrapper + + jakarta.faces.context.PartialViewContextWrapper.PartialViewContextWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:5095 + + PartialViewContextWrapper + + jakarta.faces.context.PartialViewContextWrapper.PartialViewContextWrapper +
+ ( + PartialViewContext + ) +
+
+ If this partial view context has been decorated, the implementation doing the + decorating should push the implementation being wrapped to this constructor. The #getWrapped() will + then return the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5096 + + void + + jakarta.faces.context.PartialViewContextWrapper.processPartial +
+ ( + PhaseId + ) +
+
+ The default behavior of this method is to call + PartialViewContext#processPartial(PhaseId) on the wrapped PartialViewContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5097 + + void + + jakarta.faces.context.PartialViewContextWrapper.release +
+
+
+ The default behavior of this method is to call PartialViewContext#release() on the + wrapped PartialViewContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5098 + + void + + jakarta.faces.context.PartialViewContextWrapper.setPartialRequest +
+ ( + boolean + ) +
+
+ The default behavior of this method is to call + PartialViewContext#setPartialRequest(boolean) on the wrapped PartialViewContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5099 + + void + + jakarta.faces.context.PartialViewContextWrapper.setRenderAll +
+ ( + boolean + ) +
+
+ The default behavior of this method is to call PartialViewContext#setRenderAll(boolean) + on the wrapped PartialViewContext object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5100 + + ResponseWriter + + jakarta.faces.context.ResponseWriter.cloneWithWriter +
+ ( + Writer + ) +
+
+ Create and return a new instance of this ResponseWriter, using the specified Writer as + the output destination. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5101 + + void + + jakarta.faces.context.ResponseWriter.endCDATA +
+
+
+ Close an XML CDATA block. The default implementation of this method takes no action + when invoked. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5102 + + void + + jakarta.faces.context.ResponseWriter.endCDATA +
+
+ throws + IOException +
+
+
+ if input/output error occures + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5103 + + void + + jakarta.faces.context.ResponseWriter.flush +
+
+
+ Flush any ouput buffered by the output method to the underlying Writer or OutputStream. + This method will not flush the underlying Writer or OutputStream; it simply clears any values + buffered by this ResponseWriter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5104 + + void + + jakarta.faces.context.ResponseWriter.flush +
+
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5105 + + String + + jakarta.faces.context.ResponseWriter.getCharacterEncoding +
+
+
+ Return the character encoding (such as "ISO-8859-1") for this ResponseWriter. Please + see the IANA for a list of character encodings. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5106 + + String + + jakarta.faces.context.ResponseWriter.getContentType +
+
+
+ Return the content type (such as "text/html") for this ResponseWriter. Note: this must + not include the "charset=" suffix. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5107 + + void + + jakarta.faces.context.ResponseWriter.startCDATA +
+
+
+ Open an XML CDATA block. Note that XML does not allow nested CDATA blocks, though this + method does not enforce that constraint. The default implementation of this method takes no action + when invoked. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5108 + + void + + jakarta.faces.context.ResponseWriter.startCDATA +
+
+ throws + IOException +
+
+
+ if input/output error occures + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5109 + + void + + jakarta.faces.context.ResponseWriter.startElement +
+ ( + String + , +
+ UIComponent + ) +
+
+ Write the start of an element, up to and including the element name. Once this method + has been called, clients can call the writeAttribute() or writeURIAttribute() methods to add + attributes and corresponding values. The starting element will be closed (that is, the trailing ' + gt;' character added) on any subsequent call to startElement(), writeComment(), writeText(), + endElement(), endDocument(), close(), flush(), or write(). If the argument component's pass through + attributes includes an attribute of the name given by the value of the symbolic constant + jakarta.faces.render.Renderer#PASSTHROUGH_RENDERER_LOCALNAME_KEY, use that as the element name, + instead of the value passed as the first parameter to this method. Care must be taken so that this + value is not also rendered when any other pass through attributes on this component are rendered. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5110 + + void + + jakarta.faces.context.ResponseWriter.startElement +
+ ( + String + , +
+ UIComponent + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5111 + + void + + jakarta.faces.context.ResponseWriter.writeAttribute +
+ ( + String + , +
+ Object + , +
+ String + ) +
+
+ Write an attribute name and corresponding value, after converting that text to a String + (if necessary), and after performing any escaping appropriate for the markup language being + rendered. This method may only be called after a call to startElement(), and before the opened + element has been closed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5112 + + void + + jakarta.faces.context.ResponseWriter.writeAttribute +
+ ( + String + , +
+ Object + , +
+ String + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5113 + + void + + jakarta.faces.context.ResponseWriter.writeDoctype +
+ ( + String + ) +
+
+ Write a string containing the markup specific doctype. No escaping is performed. The + default implementation simply calls through to #write(java.lang.String) . The implementation makes + no checks if this is the correct place in the response to have a doctype, nor does it prevent the + doctype from being written more than once. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5114 + + void + + jakarta.faces.context.ResponseWriter.writeDoctype +
+ ( + String + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5115 + + void + + jakarta.faces.context.ResponseWriter.writePreamble +
+ ( + String + ) +
+
+ Write a string containing the markup specific preamble. No escaping is performed. The + default implementation simply calls through to #write(java.lang.String) . The implementation makes + no checks if this is the correct place in the response to have a preamble, nor does it prevent the + preamble from being written more than once. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5116 + + void + + jakarta.faces.context.ResponseWriter.writePreamble +
+ ( + String + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5117 + + void + + jakarta.faces.context.ResponseWriter.writeText +
+ ( + Object + , +
+ String + ) +
+
+ Write an object, after converting it to a String (if necessary), and after performing + any escaping appropriate for the markup language being rendered. If there is an open element that + has been created by a call to startElement(), that element will be closed first. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5118 + + void + + jakarta.faces.context.ResponseWriter.writeText +
+ ( + Object + , +
+ String + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5119 + + void + + jakarta.faces.context.ResponseWriter.writeText +
+ ( + Object + , +
+ UIComponent + , +
+ String + ) +
+
+ Write an object, after converting it to a String (if necessary), and after performing + any escaping appropriate for the markup language being rendered. This method is equivalent to + #writeText(java.lang.Object,java.lang.String) but adds a component property to allow custom + ResponseWriter implementations to associate a component with an arbitrary portion of text. The + default implementation simply ignores the component argument and calls through to + #writeText(java.lang.Object,java.lang.String) + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5120 + + void + + jakarta.faces.context.ResponseWriter.writeText +
+ ( + Object + , +
+ UIComponent + , +
+ String + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5121 + + void + + jakarta.faces.context.ResponseWriter.writeURIAttribute +
+ ( + String + , +
+ Object + , +
+ String + ) +
+
+ Write a URI attribute name and corresponding value, after converting that text to a + String (if necessary), and after performing any encoding or escaping appropriate to the markup + language being rendered. When rendering in a WWW environment, the escaping conventions established + in the W3C URI spec document must be followed. In particular, spaces ' ' must be encoded as %20 and + not the plus character '+'. This method may only be called after a call to startElement(), and + before the opened element has been closed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5122 + + void + + jakarta.faces.context.ResponseWriter.writeURIAttribute +
+ ( + String + , +
+ Object + , +
+ String + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5123 + + ResponseWriter + + jakarta.faces.context.ResponseWriterWrapper.cloneWithWriter +
+ ( + Writer + ) +
+
+ The default behavior of this method is to call + ResponseWriter#cloneWithWriter(java.io.Writer) on the wrapped ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5124 + + void + + jakarta.faces.context.ResponseWriterWrapper.close +
+
+
+ The default behavior of this method is to call ResponseWriter#close() on the wrapped + ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5125 + + void + + jakarta.faces.context.ResponseWriterWrapper.close +
+
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5126 + + void + + jakarta.faces.context.ResponseWriterWrapper.endCDATA +
+
+
+ The default behavior of this method is to call ResponseWriter#endCDATA on the wrapped + ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5127 + + void + + jakarta.faces.context.ResponseWriterWrapper.endCDATA +
+
+ throws + IOException +
+
+
+ on any read/write error + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5128 + + void + + jakarta.faces.context.ResponseWriterWrapper.endDocument +
+
+
+ The default behavior of this method is to call ResponseWriter#endDocument() on the + wrapped ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5129 + + void + + jakarta.faces.context.ResponseWriterWrapper.endDocument +
+
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5130 + + void + + jakarta.faces.context.ResponseWriterWrapper.endElement +
+ ( + String + ) +
+
+ The default behavior of this method is to call ResponseWriter#endElement(String) on the + wrapped ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5131 + + void + + jakarta.faces.context.ResponseWriterWrapper.endElement +
+ ( + String + ) + +
+ throws + IOException +
+
+
+ on any read/write error + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5132 + + void + + jakarta.faces.context.ResponseWriterWrapper.flush +
+
+
+ The default behavior of this method is to call ResponseWriter#flush() on the wrapped + ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5133 + + void + + jakarta.faces.context.ResponseWriterWrapper.flush +
+
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5134 + + String + + jakarta.faces.context.ResponseWriterWrapper.getCharacterEncoding +
+
+
+ The default behavior of this method is to call ResponseWriter#getCharacterEncoding() on + the wrapped ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5135 + + String + + jakarta.faces.context.ResponseWriterWrapper.getContentType +
+
+
+ The default behavior of this method is to call ResponseWriter#getContentType() on the + wrapped ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5136 + + ResponseWriter + + jakarta.faces.context.ResponseWriterWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5137 + + ResponseWriterWrapper + + jakarta.faces.context.ResponseWriterWrapper.ResponseWriterWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:5138 + + ResponseWriterWrapper + + jakarta.faces.context.ResponseWriterWrapper.ResponseWriterWrapper +
+ ( + ResponseWriter + ) +
+
+ If this response writer has been decorated, the implementation doing the decorating + should push the implementation being wrapped to this constructor. The #getWrapped() will then return + the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5139 + + void + + jakarta.faces.context.ResponseWriterWrapper.startCDATA +
+
+
+ The default behavior of this method is to call ResponseWriter#startCDATA on the wrapped + ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5140 + + void + + jakarta.faces.context.ResponseWriterWrapper.startCDATA +
+
+ throws + IOException +
+
+
+ on any read/write error + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5141 + + void + + jakarta.faces.context.ResponseWriterWrapper.startDocument +
+
+
+ The default behavior of this method is to call ResponseWriter#startDocument() on the + wrapped ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5142 + + void + + jakarta.faces.context.ResponseWriterWrapper.startDocument +
+
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5143 + + void + + jakarta.faces.context.ResponseWriterWrapper.startElement +
+ ( + String + , +
+ UIComponent + ) +
+
+ The default behavior of this method is to call ResponseWriter#startElement(String, + jakarta.faces.component.UIComponent) on the wrapped ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5144 + + void + + jakarta.faces.context.ResponseWriterWrapper.startElement +
+ ( + String + , +
+ UIComponent + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5145 + + void + + jakarta.faces.context.ResponseWriterWrapper.write +
+ ( + char[] + , +
+ int + , +
+ int + ) +
+
+ The default behavior of this method is to call ResponseWriter#write(char[], int, int) + on the wrapped ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5146 + + void + + jakarta.faces.context.ResponseWriterWrapper.write +
+ ( + char[] + , +
+ int + , +
+ int + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5147 + + void + + jakarta.faces.context.ResponseWriterWrapper.writeAttribute +
+ ( + String + , +
+ Object + , +
+ String + ) +
+
+ The default behavior of this method is to call ResponseWriter#writeAttribute(String, + Object, String) on the wrapped ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5148 + + void + + jakarta.faces.context.ResponseWriterWrapper.writeAttribute +
+ ( + String + , +
+ Object + , +
+ String + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5149 + + void + + jakarta.faces.context.ResponseWriterWrapper.writeComment +
+ ( + Object + ) +
+
+ The default behavior of this method is to call ResponseWriter#writeComment(Object) on + the wrapped ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5150 + + void + + jakarta.faces.context.ResponseWriterWrapper.writeComment +
+ ( + Object + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5151 + + void + + jakarta.faces.context.ResponseWriterWrapper.writeDoctype +
+ ( + String + ) +
+
+ The default behavior of this method is to call ResponseWriter#writeDoctype on the + wrapped ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5152 + + void + + jakarta.faces.context.ResponseWriterWrapper.writeDoctype +
+ ( + String + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5153 + + void + + jakarta.faces.context.ResponseWriterWrapper.writePreamble +
+ ( + String + ) +
+
+ The default behavior of this method is to call ResponseWriter#writePreamble on the + wrapped ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5154 + + void + + jakarta.faces.context.ResponseWriterWrapper.writePreamble +
+ ( + String + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5155 + + void + + jakarta.faces.context.ResponseWriterWrapper.writeText +
+ ( + Object + , +
+ String + ) +
+
+ The default behavior of this method is to call ResponseWriter#writeText(Object, String) + on the wrapped ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5156 + + void + + jakarta.faces.context.ResponseWriterWrapper.writeText +
+ ( + Object + , +
+ String + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5157 + + void + + jakarta.faces.context.ResponseWriterWrapper.writeText +
+ ( + Object + , +
+ UIComponent + , +
+ String + ) +
+
+ The default behavior of this method is to call ResponseWriter#writeText(Object, + UIComponent, String) on the wrapped ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5158 + + void + + jakarta.faces.context.ResponseWriterWrapper.writeText +
+ ( + Object + , +
+ UIComponent + , +
+ String + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5159 + + void + + jakarta.faces.context.ResponseWriterWrapper.writeText +
+ ( + char[] + , +
+ int + , +
+ int + ) +
+
+ The default behavior of this method is to call ResponseWriter#writeText(char[], int, + int) on the wrapped ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5160 + + void + + jakarta.faces.context.ResponseWriterWrapper.writeText +
+ ( + char[] + , +
+ int + , +
+ int + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5161 + + void + + jakarta.faces.context.ResponseWriterWrapper.writeURIAttribute +
+ ( + String + , +
+ Object + , +
+ String + ) +
+
+ The default behavior of this method is to call ResponseWriter#writeURIAttribute(String, + Object, String) on the wrapped ResponseWriter object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5162 + + void + + jakarta.faces.context.ResponseWriterWrapper.writeURIAttribute +
+ ( + String + , +
+ Object + , +
+ String + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5163 + + BigDecimalConverter + + jakarta.faces.convert.BigDecimalConverter.BigDecimalConverter +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5164 + + Object + + jakarta.faces.convert.BigDecimalConverter.getAsObject +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Convert the specified string value, which is associated with the specified UIComponent, + into a model data object that is appropriate for being stored during the Process Validations phase + of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5165 + + String + + jakarta.faces.convert.BigDecimalConverter.getAsString +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5166 + + BigIntegerConverter + + jakarta.faces.convert.BigIntegerConverter.BigIntegerConverter +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5167 + + Object + + jakarta.faces.convert.BigIntegerConverter.getAsObject +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Convert the specified string value, which is associated with the specified UIComponent, + into a model data object that is appropriate for being stored during the Process Validations phase + of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5168 + + String + + jakarta.faces.convert.BigIntegerConverter.getAsString +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5169 + + BooleanConverter + + jakarta.faces.convert.BooleanConverter.BooleanConverter +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5170 + + Object + + jakarta.faces.convert.BooleanConverter.getAsObject +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Convert the specified string value, which is associated with the specified UIComponent, + into a model data object that is appropriate for being stored during the Process Validations phase + of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5171 + + String + + jakarta.faces.convert.BooleanConverter.getAsString +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5172 + + ByteConverter + + jakarta.faces.convert.ByteConverter.ByteConverter +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5173 + + Object + + jakarta.faces.convert.ByteConverter.getAsObject +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Convert the specified string value, which is associated with the specified UIComponent, + into a model data object that is appropriate for being stored during the Process Validations phase + of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5174 + + String + + jakarta.faces.convert.ByteConverter.getAsString +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5175 + + CharacterConverter + + jakarta.faces.convert.CharacterConverter.CharacterConverter +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5176 + + Object + + jakarta.faces.convert.CharacterConverter.getAsObject +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Convert the specified string value, which is associated with the specified UIComponent, + into a model data object that is appropriate for being stored during the Process Validations phase + of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5177 + + String + + jakarta.faces.convert.CharacterConverter.getAsString +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5178 + + ConverterException + + jakarta.faces.convert.ConverterException.ConverterException +
+ ( + FacesMessage + ) +
+
+ Construct a new exception with the specified detail message and no root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5179 + + ConverterException + + jakarta.faces.convert.ConverterException.ConverterException +
+ ( + FacesMessage + , +
+ Throwable + ) +
+
+ Construct a new exception with the specified detail message and root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5180 + + FacesMessage + + jakarta.faces.convert.ConverterException.getFacesMessage +
+
+
+ Returns the FacesMessage associated with this exception; this will only be available if + the converter that thew this exception instance placed it there. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5181 + + void + + jakarta.faces.convert.DateTimeConverter.clearInitialState +
+
+
+ Reset the PartialStateHolder to a non-delta tracking state. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5182 + + DateTimeConverter + + jakarta.faces.convert.DateTimeConverter.DateTimeConverter +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5183 + + Object + + jakarta.faces.convert.DateTimeConverter.getAsObject +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Convert the specified string value, which is associated with the specified UIComponent, + into a model data object that is appropriate for being stored during the Process Validations phase + of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5184 + + String + + jakarta.faces.convert.DateTimeConverter.getAsString +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5185 + + String + + jakarta.faces.convert.DateTimeConverter.getDateStyle +
+
+
+ Return the style to be used to format or parse dates. If not set, the default value, + default, is returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5186 + + Locale + + jakarta.faces.convert.DateTimeConverter.getLocale +
+
+
+ Return the Locale to be used when parsing or formatting dates and times. If not + explicitly set, the Locale stored in the jakarta.faces.component.UIViewRoot for the current request + is returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5187 + + String + + jakarta.faces.convert.DateTimeConverter.getPattern +
+
+
+ Return the format pattern to be used when formatting and parsing dates and times. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5188 + + String + + jakarta.faces.convert.DateTimeConverter.getTimeStyle +
+
+
+ Return the style to be used to format or parse times. If not set, the default value, + default, is returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5189 + + TimeZone + + jakarta.faces.convert.DateTimeConverter.getTimeZone +
+
+
+ Return the TimeZone used to interpret a time value. If not explicitly set, the default + time zone of GMT returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5190 + + String + + jakarta.faces.convert.DateTimeConverter.getType +
+
+
+ Return the type of value to be formatted or parsed. If not explicitly set, the default + type, date is returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5191 + + boolean + + jakarta.faces.convert.DateTimeConverter.initialStateMarked +
+
+
+ Return true if delta state changes are being tracked, otherwise false + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5192 + + boolean + + jakarta.faces.convert.DateTimeConverter.isTransient +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5193 + + void + + jakarta.faces.convert.DateTimeConverter.markInitialState +
+
+
+ The runtime must ensure that the #markInitialState method is called on each instance of + this interface in the view at the appropriate time to indicate the component is in its initial + state. The implementor of the interface must ensure that #initialStateMarked returns true from the + time markInitialState() is called until #clearInitialState is called, after which time + initialStateMarked() must return false. Also, during the time that the instance returns true from + initialStateMarked(), the implementation must return only the state that has changed in its + implementation of StateHolder#saveState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5194 + + void + + jakarta.faces.convert.DateTimeConverter.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5195 + + Object + + jakarta.faces.convert.DateTimeConverter.saveState +
+ ( + FacesContext + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5196 + + void + + jakarta.faces.convert.DateTimeConverter.setDateStyle +
+ ( + String + ) +
+
+ Set the style to be used to format or parse dates. Valid values are default, short, + medium, long, and full. An invalid value will cause a ConverterException when getAsObject() or + getAsString() is called. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5197 + + void + + jakarta.faces.convert.DateTimeConverter.setLocale +
+ ( + Locale + ) +
+
+ Set the Locale to be used when parsing or formatting dates and times. If set to null, + the Locale stored in the jakarta.faces.component.UIViewRoot for the current request will be + utilized. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5198 + + void + + jakarta.faces.convert.DateTimeConverter.setPattern +
+ ( + String + ) +
+
+ Set the format pattern to be used when formatting and parsing dates and times. Valid + values are those supported by java.text.SimpleDateFormat. An invalid value will cause a + ConverterException when getAsObject() or getAsString() is called. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5199 + + void + + jakarta.faces.convert.DateTimeConverter.setTimeStyle +
+ ( + String + ) +
+
+ Set the style to be used to format or parse times. Valid values are default, short, + medium, long, and full. An invalid value will cause a ConverterException when getAsObject() or + getAsString() is called. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5200 + + void + + jakarta.faces.convert.DateTimeConverter.setTimeZone +
+ ( + TimeZone + ) +
+
+ Set the TimeZone used to interpret a time value. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5201 + + void + + jakarta.faces.convert.DateTimeConverter.setTransient +
+ ( + boolean + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5202 + + void + + jakarta.faces.convert.DateTimeConverter.setType +
+ ( + String + ) +
+
+ Set the type of value to be formatted or parsed. Valid values are both, date, time + localDate, localDateTime, localTime, offsetTime, offsetDateTime, or zonedDateTime. The values + starting with "local", "offset" and "zoned" correspond to Java SE 8 Date Time API classes in package + java.time with the name derived by upper casing the first letter. For example, java.time.LocalDate + for the value "localDate". An invalid value will cause a ConverterException when getAsObject() or + getAsString() is called. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5203 + + DoubleConverter + + jakarta.faces.convert.DoubleConverter.DoubleConverter +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5204 + + Object + + jakarta.faces.convert.DoubleConverter.getAsObject +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Convert the specified string value, which is associated with the specified UIComponent, + into a model data object that is appropriate for being stored during the Process Validations phase + of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5205 + + String + + jakarta.faces.convert.DoubleConverter.getAsString +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5206 + + void + + jakarta.faces.convert.EnumConverter.clearInitialState +
+
+
+ Reset the PartialStateHolder to a non-delta tracking state. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5207 + + EnumConverter + + jakarta.faces.convert.EnumConverter.EnumConverter +
+
+
+ For StateHolder + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5208 + + EnumConverter + + jakarta.faces.convert.EnumConverter.EnumConverter +
+ ( + Class + ) +
+
+ Instantiates an enum converter with a class where enum constants are taken from. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5209 + + Object + + jakarta.faces.convert.EnumConverter.getAsObject +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Convert the value argument to one of the enum constants of the class provided in our + constructor. If no target class argument has been provided to the constructor of this instance, + throw a ConverterException containing the #ENUM_NO_CLASS_ID message with proper parameters. If the + value argument is null or it has a length of zero, return null. Otherwise, perform the equivalent of + Enum.valueOf using target class and value and return the Object. If the conversion fails, throw a + ConverterException containing the #ENUM_ID message with proper parameters. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5210 + + String + + jakarta.faces.convert.EnumConverter.getAsString +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ Convert the enum constant given by the value argument into a String. If no target class + argument has been provided to the constructor of this instance, throw a ConverterException + containing the #ENUM_NO_CLASS_ID message with proper parameters. If the value argument is null, + return the empty String. If the value is an instance of the provided target class, return its string + value by casting it to a java.lang.Enum and returning the result of calling the name() method. + Otherwise, throw a ConverterException containing the #ENUM_ID message with proper parameters. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5211 + + boolean + + jakarta.faces.convert.EnumConverter.initialStateMarked +
+
+
+ Return true if delta state changes are being tracked, otherwise false + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5212 + + boolean + + jakarta.faces.convert.EnumConverter.isTransient +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5213 + + void + + jakarta.faces.convert.EnumConverter.markInitialState +
+
+
+ The runtime must ensure that the #markInitialState method is called on each instance of + this interface in the view at the appropriate time to indicate the component is in its initial + state. The implementor of the interface must ensure that #initialStateMarked returns true from the + time markInitialState() is called until #clearInitialState is called, after which time + initialStateMarked() must return false. Also, during the time that the instance returns true from + initialStateMarked(), the implementation must return only the state that has changed in its + implementation of StateHolder#saveState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5214 + + void + + jakarta.faces.convert.EnumConverter.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5215 + + Object + + jakarta.faces.convert.EnumConverter.saveState +
+ ( + FacesContext + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5216 + + void + + jakarta.faces.convert.EnumConverter.setTransient +
+ ( + boolean + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5217 + + Class + + jakarta.faces.convert.FacesConverter.forClass +
+
+
+ The value of this annotation attribute is taken to be the converter-for-class with + which instances of this class of converter can be instantiated by calling + jakarta.faces.application.Application#createConverter(java.lang.Class). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5218 + + boolean + + jakarta.faces.convert.FacesConverter.managed +
+
+
+ The value of this annotation attribute is taken to be an indicator that flags whether + or not the given converter is a CDI managed converter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5219 + + String + + jakarta.faces.convert.FacesConverter.value +
+
+
+ The value of this annotation attribute is taken to be the converter-id with which + instances of this class of converter can be instantiated by calling + jakarta.faces.application.Application#createConverter(java.lang.String). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5220 + + Class + + jakarta.faces.convert.FacesConverter.Literal.forClass +
+
+
+ The value of this annotation attribute is taken to be the converter-for-class with + which instances of this class of converter can be instantiated by calling + jakarta.faces.application.Application#createConverter(java.lang.Class). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5221 + + boolean + + jakarta.faces.convert.FacesConverter.Literal.managed +
+
+
+ The value of this annotation attribute is taken to be an indicator that flags whether + or not the given converter is a CDI managed converter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5222 + + Literal + + jakarta.faces.convert.FacesConverter.Literal.of +
+ ( + String + , +
+ Class + , +
+ boolean + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5223 + + String + + jakarta.faces.convert.FacesConverter.Literal.value +
+
+
+ The value of this annotation attribute is taken to be the converter-id with which + instances of this class of converter can be instantiated by calling + jakarta.faces.application.Application#createConverter(java.lang.String). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5224 + + FloatConverter + + jakarta.faces.convert.FloatConverter.FloatConverter +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5225 + + Object + + jakarta.faces.convert.FloatConverter.getAsObject +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Convert the specified string value, which is associated with the specified UIComponent, + into a model data object that is appropriate for being stored during the Process Validations phase + of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5226 + + String + + jakarta.faces.convert.FloatConverter.getAsString +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5227 + + Object + + jakarta.faces.convert.IntegerConverter.getAsObject +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Convert the specified string value, which is associated with the specified UIComponent, + into a model data object that is appropriate for being stored during the Process Validations phase + of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5228 + + String + + jakarta.faces.convert.IntegerConverter.getAsString +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5229 + + IntegerConverter + + jakarta.faces.convert.IntegerConverter.IntegerConverter +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5230 + + Object + + jakarta.faces.convert.LongConverter.getAsObject +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Convert the specified string value, which is associated with the specified UIComponent, + into a model data object that is appropriate for being stored during the Process Validations phase + of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5231 + + String + + jakarta.faces.convert.LongConverter.getAsString +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5232 + + LongConverter + + jakarta.faces.convert.LongConverter.LongConverter +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5233 + + void + + jakarta.faces.convert.NumberConverter.clearInitialState +
+
+
+ Reset the PartialStateHolder to a non-delta tracking state. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5234 + + Object + + jakarta.faces.convert.NumberConverter.getAsObject +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Convert the specified string value, which is associated with the specified UIComponent, + into a model data object that is appropriate for being stored during the Process Validations phase + of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5235 + + String + + jakarta.faces.convert.NumberConverter.getAsString +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5236 + + String + + jakarta.faces.convert.NumberConverter.getCurrencyCode +
+
+
+ Return the ISO 4217 currency code used by getAsString() with a type of currency. If not + set, the value used will be based on the formatting Locale. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5237 + + String + + jakarta.faces.convert.NumberConverter.getCurrencySymbol +
+
+
+ Return the currency symbol used by getAsString() with a type of currency. If not set, + the value used will be based on the formatting Locale. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5238 + + Locale + + jakarta.faces.convert.NumberConverter.getLocale +
+
+
+ Return the Locale to be used when parsing numbers. If this value is null, the Locale + stored in the jakarta.faces.component.UIViewRoot for the current request will be utilized. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5239 + + int + + jakarta.faces.convert.NumberConverter.getMaxFractionDigits +
+
+
+ Return the maximum number of digits getAsString() should render in the fraction portion + of the result. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5240 + + int + + jakarta.faces.convert.NumberConverter.getMaxIntegerDigits +
+
+
+ Return the maximum number of digits getAsString() should render in the integer portion + of the result. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5241 + + int + + jakarta.faces.convert.NumberConverter.getMinFractionDigits +
+
+
+ Return the minimum number of digits getAsString() should render in the fraction portion + of the result. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5242 + + int + + jakarta.faces.convert.NumberConverter.getMinIntegerDigits +
+
+
+ Return the minimum number of digits getAsString() should render in the integer portion + of the result. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5243 + + String + + jakarta.faces.convert.NumberConverter.getPattern +
+
+
+ Return the format pattern to be used when formatting and parsing numbers. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5244 + + String + + jakarta.faces.convert.NumberConverter.getType +
+
+
+ Return the number type to be used when formatting and parsing numbers. If not modified, + the default type is number. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5245 + + boolean + + jakarta.faces.convert.NumberConverter.initialStateMarked +
+
+
+ Return true if delta state changes are being tracked, otherwise false + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5246 + + boolean + + jakarta.faces.convert.NumberConverter.isGroupingUsed +
+
+
+ Return true if getAsString should include grouping separators if necessary. If not + modified, the default value is true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5247 + + boolean + + jakarta.faces.convert.NumberConverter.isIntegerOnly +
+
+
+ Return true if only the integer portion of the given value should be returned from + getAsObject(). If not modified, the default value is false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5248 + + boolean + + jakarta.faces.convert.NumberConverter.isTransient +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5249 + + void + + jakarta.faces.convert.NumberConverter.markInitialState +
+
+
+ The runtime must ensure that the #markInitialState method is called on each instance of + this interface in the view at the appropriate time to indicate the component is in its initial + state. The implementor of the interface must ensure that #initialStateMarked returns true from the + time markInitialState() is called until #clearInitialState is called, after which time + initialStateMarked() must return false. Also, during the time that the instance returns true from + initialStateMarked(), the implementation must return only the state that has changed in its + implementation of StateHolder#saveState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5250 + + NumberConverter + + jakarta.faces.convert.NumberConverter.NumberConverter +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5251 + + void + + jakarta.faces.convert.NumberConverter.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5252 + + Object + + jakarta.faces.convert.NumberConverter.saveState +
+ ( + FacesContext + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5253 + + void + + jakarta.faces.convert.NumberConverter.setCurrencyCode +
+ ( + String + ) +
+
+ Set the ISO 4217 currency code used by getAsString() with a type of currency. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5254 + + void + + jakarta.faces.convert.NumberConverter.setCurrencySymbol +
+ ( + String + ) +
+
+ Set the currency symbol used by getAsString() with a type of currency. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5255 + + void + + jakarta.faces.convert.NumberConverter.setGroupingUsed +
+ ( + boolean + ) +
+
+ Set the flag indicating whether getAsString() should include grouping separators if + necessary. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5256 + + void + + jakarta.faces.convert.NumberConverter.setIntegerOnly +
+ ( + boolean + ) +
+
+ Set to true if only the integer portion of the given value should be returned from + getAsObject(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5257 + + void + + jakarta.faces.convert.NumberConverter.setLocale +
+ ( + Locale + ) +
+
+ Set the Locale to be used when parsing numbers. If set to null, the Locale stored in + the jakarta.faces.component.UIViewRoot for the current request will be utilized. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5258 + + void + + jakarta.faces.convert.NumberConverter.setMaxFractionDigits +
+ ( + int + ) +
+
+ Set the maximum number of digits getAsString() should render in the fraction portion of + the result. If not set, the number of digits depends on the value being converted. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5259 + + void + + jakarta.faces.convert.NumberConverter.setMaxIntegerDigits +
+ ( + int + ) +
+
+ Set the maximum number of digits getAsString() should render in the integer portion of + the result. If not set, the number of digits depends on the value being converted. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5260 + + void + + jakarta.faces.convert.NumberConverter.setMinFractionDigits +
+ ( + int + ) +
+
+ Set the minimum number of digits getAsString() should render in the fraction portion of + the result. If not set, the number of digits depends on the value being converted. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5261 + + void + + jakarta.faces.convert.NumberConverter.setMinIntegerDigits +
+ ( + int + ) +
+
+ Set the minimum number of digits getAsString() should render in the integer portion of + the result. If not set, the number of digits depends on the value being converted. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5262 + + void + + jakarta.faces.convert.NumberConverter.setPattern +
+ ( + String + ) +
+
+ Set the format pattern to be used when formatting and parsing numbers. Valid values are + those supported by java.text.DecimalFormat. An invalid value will cause a ConverterException when + getAsObject() or getAsString() is called. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5263 + + void + + jakarta.faces.convert.NumberConverter.setTransient +
+ ( + boolean + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5264 + + void + + jakarta.faces.convert.NumberConverter.setType +
+ ( + String + ) +
+
+ Set the number type to be used when formatting and parsing numbers. Valid values are + currency, number, or percent. An invalid value will cause a ConverterException when getAsObject() or + getAsString() is called. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5265 + + Object + + jakarta.faces.convert.ShortConverter.getAsObject +
+ ( + FacesContext + , +
+ UIComponent + , +
+ String + ) +
+
+ Convert the specified string value, which is associated with the specified UIComponent, + into a model data object that is appropriate for being stored during the Process Validations phase + of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5266 + + String + + jakarta.faces.convert.ShortConverter.getAsString +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5267 + + ShortConverter + + jakarta.faces.convert.ShortConverter.ShortConverter +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5268 + + ValueExpression + + jakarta.faces.el.CompositeComponentExpressionHolder.getExpression +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5269 + + AbortProcessingException + + jakarta.faces.event.AbortProcessingException.AbortProcessingException +
+ ( + String + ) +
+
+ Construct a new exception with the specified detail message and no root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5270 + + AbortProcessingException + + jakarta.faces.event.AbortProcessingException.AbortProcessingException +
+ ( + Throwable + ) +
+
+ Construct a new exception with the specified root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5271 + + AbortProcessingException + + jakarta.faces.event.AbortProcessingException.AbortProcessingException +
+ ( + String + , +
+ Throwable + ) +
+
+ Construct a new exception with the specified detail message and root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5272 + + ActionEvent + + jakarta.faces.event.ActionEvent.ActionEvent +
+ ( + UIComponent + ) +
+
+ Construct a new event object from the specified source component and action command. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5273 + + ActionEvent + + jakarta.faces.event.ActionEvent.ActionEvent +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Construct a new event object from the Faces context, specified source component and + action command. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5274 + + boolean + + jakarta.faces.event.ActionEvent.isAppropriateListener +
+ ( + FacesListener + ) +
+
+ Return true if this FacesListener is an instance of a listener class that this event + supports. Typically, this will be accomplished by an "instanceof" check on the listener class. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5275 + + void + + jakarta.faces.event.ActionEvent.processListener +
+ ( + FacesListener + ) +
+
+ Broadcast this FacesEvent to the specified FacesListener, by whatever mechanism is + appropriate. Typically, this will be accomplished by calling an event processing method, and passing + this FacesEvent as a paramter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5276 + + ActionListenerWrapper + + jakarta.faces.event.ActionListenerWrapper.ActionListenerWrapper +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5277 + + ActionListener + + jakarta.faces.event.ActionListenerWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5278 + + void + + jakarta.faces.event.ActionListenerWrapper.processAction +
+ ( + ActionEvent + ) +
+
+ Invoked when the action described by the specified ActionEvent occurs. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5279 + + void + + jakarta.faces.event.ActionListenerWrapper.processAction +
+ ( + ActionEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ Signal the Jakarta Faces implementation that no further processing on the current event + should be performed + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5280 + + AjaxBehaviorEvent + + jakarta.faces.event.AjaxBehaviorEvent.AjaxBehaviorEvent +
+ ( + UIComponent + , +
+ Behavior + ) +
+
+ Construct a new event object from the specified source component and Ajax behavior. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5281 + + AjaxBehaviorEvent + + jakarta.faces.event.AjaxBehaviorEvent.AjaxBehaviorEvent +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Behavior + ) +
+
+ Construct a new event object from the Faces context, specified source component and + Ajax behavior. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5282 + + boolean + + jakarta.faces.event.AjaxBehaviorEvent.isAppropriateListener +
+ ( + FacesListener + ) +
+
+ Return true if this FacesListener is an instance of a the appropriate listener class + that this event supports. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5283 + + void + + jakarta.faces.event.AjaxBehaviorEvent.processListener +
+ ( + FacesListener + ) +
+
+ Broadcast this event instance to the specified FacesListener, by whatever mechanism is + appropriate. Typically, this will be accomplished by calling an event processing method, and passing + this instance as a parameter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5284 + + void + + jakarta.faces.event.AjaxBehaviorListener.processAjaxBehavior +
+ ( + AjaxBehaviorEvent + ) +
+
+ Process the Ajax behavior event. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5285 + + void + + jakarta.faces.event.AjaxBehaviorListener.processAjaxBehavior +
+ ( + AjaxBehaviorEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ if lifecycle processing should cease for this request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5286 + + BehaviorEvent + + jakarta.faces.event.BehaviorEvent.BehaviorEvent +
+ ( + UIComponent + , +
+ Behavior + ) +
+
+ Construct a new event object from the specified source component and behavior. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5287 + + BehaviorEvent + + jakarta.faces.event.BehaviorEvent.BehaviorEvent +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Behavior + ) +
+
+ Construct a new event object from the Faces context, specified source component and + behavior. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5288 + + Behavior + + jakarta.faces.event.BehaviorEvent.getBehavior +
+
+
+ Return the source Behavior that sent this event. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5289 + + ComponentSystemEvent + + jakarta.faces.event.ComponentSystemEvent.ComponentSystemEvent +
+ ( + UIComponent + ) +
+
+ Pass the argument component to the superclass constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5290 + + ComponentSystemEvent + + jakarta.faces.event.ComponentSystemEvent.ComponentSystemEvent +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Pass the argument component to the superclass constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5291 + + UIComponent + + jakarta.faces.event.ComponentSystemEvent.getComponent +
+
+
+ the source UIComponent that sent this event. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5292 + + boolean + + jakarta.faces.event.ComponentSystemEvent.isAppropriateListener +
+ ( + FacesListener + ) +
+
+ Return true if the argument FacesListener is an instance of the appropriate listener + class that this event supports. The default implementation returns true if the listener is a + ComponentSystemEventListener or if super.isAppropriateListener() returns true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5293 + + void + + jakarta.faces.event.ComponentSystemEvent.processListener +
+ ( + FacesListener + ) +
+
+ Broadcast this event instance to the specified FacesListener by calling the + superclass's processListener() implementation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5294 + + void + + jakarta.faces.event.ComponentSystemEventListener.processEvent +
+ ( + ComponentSystemEvent + ) +
+
+ When called, the listener can assume that any guarantees given in the javadoc for the + specific SystemEvent subclass are true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5295 + + void + + jakarta.faces.event.ComponentSystemEventListener.processEvent +
+ ( + ComponentSystemEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ if lifecycle processing should cease for this request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5296 + + ExceptionQueuedEvent + + jakarta.faces.event.ExceptionQueuedEvent.ExceptionQueuedEvent +
+ ( + ExceptionQueuedEventContext + ) +
+
+ Instantiate a new ExceptionQueuedEvent that indicates the argument + ExceptionQueuedEventContext occurred. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5297 + + ExceptionQueuedEvent + + jakarta.faces.event.ExceptionQueuedEvent.ExceptionQueuedEvent +
+ ( + FacesContext + , +
+ ExceptionQueuedEventContext + ) +
+
+ Instantiate a new ExceptionQueuedEvent that indicates the argument + ExceptionQueuedEventContext occurred. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5298 + + ExceptionQueuedEventContext + + jakarta.faces.event.ExceptionQueuedEvent.getContext +
+
+
+ Return the ExceptionQueuedEventContext for this event instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5299 + + ExceptionQueuedEventContext + + jakarta.faces.event.ExceptionQueuedEventContext.ExceptionQueuedEventContext +
+ ( + FacesContext + , +
+ Throwable + ) +
+
+ Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable + just occurred. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5300 + + ExceptionQueuedEventContext + + jakarta.faces.event.ExceptionQueuedEventContext.ExceptionQueuedEventContext +
+ ( + FacesContext + , +
+ Throwable + , +
+ UIComponent + ) +
+
+ Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable + just occurred, relevant to the argument component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5301 + + ExceptionQueuedEventContext + + jakarta.faces.event.ExceptionQueuedEventContext.ExceptionQueuedEventContext +
+ ( + FacesContext + , +
+ Throwable + , +
+ UIComponent + , +
+ PhaseId + ) +
+
+ Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable + just occurred, relevant to the argument component, during the lifecycle phase phaseId. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5302 + + Map + + jakarta.faces.event.ExceptionQueuedEventContext.getAttributes +
+
+
+ A Map of attributes relevant to the context of this ExceptionQueuedEvent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5303 + + UIComponent + + jakarta.faces.event.ExceptionQueuedEventContext.getComponent +
+
+
+ Return the UIComponent which was being processed when the exception was thrown. If none + or not available, this will be null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5304 + + FacesContext + + jakarta.faces.event.ExceptionQueuedEventContext.getContext +
+
+
+ The FacesContext for this request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5305 + + Throwable + + jakarta.faces.event.ExceptionQueuedEventContext.getException +
+
+
+ Return the exception property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5306 + + List + + jakarta.faces.event.ExceptionQueuedEventContext.getListenersForEventClass +
+ ( + Class + ) +
+
+ Return a List that contains a single entry, the jakarta.faces.context.ExceptionHandler + for the current request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5307 + + PhaseId + + jakarta.faces.event.ExceptionQueuedEventContext.getPhaseId +
+
+
+ Return the PhaseId which was being processed when the exception was thrown. If none or + not available, this will be null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5308 + + boolean + + jakarta.faces.event.ExceptionQueuedEventContext.inAfterPhase +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5309 + + boolean + + jakarta.faces.event.ExceptionQueuedEventContext.inBeforePhase +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5310 + + FacesEvent + + jakarta.faces.event.FacesEvent.FacesEvent +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Construct a new event object from the Faces context and specified source component. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5311 + + FacesContext + + jakarta.faces.event.FacesEvent.getFacesContext +
+
+
+ Get the Faces context. If the constructor was passed a FacesContext we return it, + otherwise we call FacesContext.getCurrentInstance() and return it. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5312 + + PhaseId + + jakarta.faces.event.FacesEvent.getPhaseId +
+
+
+ Return the identifier of the request processing phase during which this event should be + delivered. Legal values are the singleton instances defined by the PhaseId class, including + PhaseId.ANY_PHASE, which is the default value. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5313 + + boolean + + jakarta.faces.event.FacesEvent.isAppropriateListener +
+ ( + FacesListener + ) +
+
+ Return true if this FacesListener is an instance of a listener class that this event + supports. Typically, this will be accomplished by an "instanceof" check on the listener class. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5314 + + void + + jakarta.faces.event.FacesEvent.processListener +
+ ( + FacesListener + ) +
+
+ Broadcast this FacesEvent to the specified FacesListener, by whatever mechanism is + appropriate. Typically, this will be accomplished by calling an event processing method, and passing + this FacesEvent as a paramter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5315 + + void + + jakarta.faces.event.FacesEvent.queue +
+
+
+ Convenience method to queue this event for broadcast at the end of the current request + processing lifecycle phase. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5316 + + void + + jakarta.faces.event.FacesEvent.setPhaseId +
+ ( + PhaseId + ) +
+
+ Set the PhaseId during which this event will be delivered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5317 + + Class + + jakarta.faces.event.ListenerFor.sourceClass +
+
+
+ The kind of object that emits events of the type given by the value of the + #systemEventClass attribute. It is valid to have Jakarta Expression Language Expressions in the + value of this attribute, as long as the expression resolves to an instance of the expected type. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5318 + + Class + + jakarta.faces.event.ListenerFor.systemEventClass +
+
+
+ The kind of system event for which this class will be installed as a listener. The + implementation only supports exact matches on the Class and must not honor subclass relationships. + It is valid to have EL Expressions in the value of this attribute, as long as the expression + resolves to an instance of the expected type. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5319 + + ListenerFor[] + + jakarta.faces.event.ListenersFor.value +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5320 + + boolean + + jakarta.faces.event.MethodExpressionActionListener.isTransient +
+
+
+ If true, the Object implementing this interface must not participate in state saving or + restoring. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5321 + + MethodExpressionActionListener + + jakarta.faces.event.MethodExpressionActionListener.MethodExpressionActionListener +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5322 + + MethodExpressionActionListener + + jakarta.faces.event.MethodExpressionActionListener.MethodExpressionActionListener +
+ ( + MethodExpression + ) +
+
+ Construct a ValueChangeListener that contains a MethodExpression. To accomodate method + expression targets that take no arguments instead of taking an ActionEvent argument, the + implementation of this class must take the argument methodExpressionOneArg, extract its expression + string, and create another MethodExpression whose expected param types match those of a zero + argument method. The usage requirements for both of these MethodExpression instances are described + in #processAction. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5323 + + MethodExpressionActionListener + + jakarta.faces.event.MethodExpressionActionListener.MethodExpressionActionListener +
+ ( + MethodExpression + , +
+ MethodExpression + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5324 + + void + + jakarta.faces.event.MethodExpressionActionListener.processAction +
+ ( + ActionEvent + ) +
+
+ Call through to the MethodExpression passed in our constructor. First, try to invoke + the MethodExpression passed to the constructor of this instance, passing the argument ActionEvent as + the argument. If a MethodNotFoundException is thrown, call to the zero argument MethodExpression + derived from the MethodExpression passed to the constructor of this instance. If that fails for any + reason, throw an AbortProcessingException, including the cause of the failure. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5325 + + void + + jakarta.faces.event.MethodExpressionActionListener.processAction +
+ ( + ActionEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ {@inheritDoc} + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5326 + + void + + jakarta.faces.event.MethodExpressionActionListener.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ Both MethodExpression instances described in the constructor must be restored. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5327 + + Object + + jakarta.faces.event.MethodExpressionActionListener.saveState +
+ ( + FacesContext + ) +
+
+ Both MethodExpression instances described in the constructor must be saved. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5328 + + void + + jakarta.faces.event.MethodExpressionActionListener.setTransient +
+ ( + boolean + ) +
+
+ Denotes whether or not the Object implementing this interface must or must not + participate in state saving or restoring. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5329 + + boolean + + jakarta.faces.event.MethodExpressionValueChangeListener.isTransient +
+
+
+ If true, the Object implementing this interface must not participate in state saving or + restoring. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5330 + + MethodExpressionValueChangeListener + + + jakarta.faces.event.MethodExpressionValueChangeListener.MethodExpressionValueChangeListener +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5331 + + MethodExpressionValueChangeListener + + + jakarta.faces.event.MethodExpressionValueChangeListener.MethodExpressionValueChangeListener +
+ ( + MethodExpression + ) +
+
+ Construct a ValueChangeListener that contains a MethodExpression.To accommodate method + expression targets that take no arguments instead of taking a ValueChangeEvent argument, the + implementation of this class must take the argument methodExpressionOneArg, extract its expression + string, and create another MethodExpression whose expected param types match those of a zero + argument method. The usage requirements for both of these MethodExpression instances are described + in #processValueChange. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5332 + + MethodExpressionValueChangeListener + + + jakarta.faces.event.MethodExpressionValueChangeListener.MethodExpressionValueChangeListener +
+ ( + MethodExpression + , +
+ MethodExpression + ) +
+
+ Construct a ValueChangeListener that contains a MethodExpression. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5333 + + void + + jakarta.faces.event.MethodExpressionValueChangeListener.processValueChange +
+ ( + ValueChangeEvent + ) +
+
+ Call through to the MethodExpression passed in our constructor. First, try to invoke + the MethodExpression passed to the constructor of this instance, passing the argument + ValueChangeEvent as the argument. If a MethodNotFoundException is thrown, call to the zero argument + MethodExpression derived from the MethodExpression passed to the constructor of this instance. If + that fails for any reason, throw an AbortProcessingException, including the cause of the failure. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5334 + + void + + jakarta.faces.event.MethodExpressionValueChangeListener.processValueChange +
+ ( + ValueChangeEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ {@inheritDoc} + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5335 + + void + + jakarta.faces.event.MethodExpressionValueChangeListener.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ Both MethodExpression instances described in the constructor must be restored. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5336 + + Object + + jakarta.faces.event.MethodExpressionValueChangeListener.saveState +
+ ( + FacesContext + ) +
+
+ Both MethodExpression instances described in the constructor must be saved. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5337 + + void + + jakarta.faces.event.MethodExpressionValueChangeListener.setTransient +
+ ( + boolean + ) +
+
+ Denotes whether or not the Object implementing this interface must or must not + participate in state saving or restoring. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5338 + + String + + jakarta.faces.event.NamedEvent.shortName +
+
+
+ The value of this annotation attribute is taken to be the short name for the + jakarta.faces.event.ComponentSystemEvent. If the value of this attribute is ommitted, the following + algorithm must be used by the code that processes this annotation to determine its value. Get the + unqualified class name (e.g., UserLoginEvent) Strip off the trailing "Event", if present (e.g., + UserLogin) Convert the first character to lower-case (e.g., userLogin) Prepend the package name to + the lower-cased name. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5339 + + FacesContext + + jakarta.faces.event.PhaseEvent.getFacesContext +
+
+
+ Return the FacesContext for the request being processed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5340 + + PhaseId + + jakarta.faces.event.PhaseEvent.getPhaseId +
+
+
+ Return the PhaseId representing the current request processing lifecycle phase. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5341 + + PhaseEvent + + jakarta.faces.event.PhaseEvent.PhaseEvent +
+ ( + FacesContext + , +
+ PhaseId + , +
+ Lifecycle + ) +
+
+ Construct a new event object from the specified parameters. The specified Lifecycle + will be the source of this event. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5342 + + String + + jakarta.faces.event.PhaseId.getName +
+
+
+ Return the name of this phase. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5343 + + PhaseId + + jakarta.faces.event.PhaseId.phaseIdValueOf +
+ ( + String + ) +
+
+ Return a PhaseId representation of the arcument phase. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5344 + + void + + jakarta.faces.event.PhaseListener.afterPhase +
+ ( + PhaseEvent + ) +
+
+ Handle a notification that the processing for a particular phase has just been + completed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5345 + + void + + jakarta.faces.event.PhaseListener.beforePhase +
+ ( + PhaseEvent + ) +
+
+ Handle a notification that the processing for a particular phase of the request + processing lifecycle is about to begin. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5346 + + PhaseId + + jakarta.faces.event.PhaseListener.getPhaseId +
+
+
+ Return the identifier of the request processing phase during which this listener is + interested in processing PhaseEvent events. Legal values are the singleton instances defined by the + PhaseId class, including PhaseId.ANY_PHASE to indicate an interest in being notified for all + standard phases. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5347 + + boolean + + jakarta.faces.event.PostAddToViewEvent.isAppropriateListener +
+ ( + FacesListener + ) +
+
+ Returns true if and only if the argument listener is an instance of + SystemEventListener. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5348 + + PostAddToViewEvent + + jakarta.faces.event.PostAddToViewEvent.PostAddToViewEvent +
+ ( + UIComponent + ) +
+
+ Instantiate a new PostAddToViewEvent that indicates the argument component was just + added to the view. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5349 + + PostAddToViewEvent + + jakarta.faces.event.PostAddToViewEvent.PostAddToViewEvent +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Instantiate a new PostAddToViewEvent that indicates the argument component was just + added to the view. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5350 + + Application + + jakarta.faces.event.PostConstructApplicationEvent.getApplication +
+
+
+ The source Application that sent this event. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5351 + + PostConstructApplicationEvent + + jakarta.faces.event.PostConstructApplicationEvent.PostConstructApplicationEvent +
+ ( + Application + ) +
+
+ Constructs a new PostConstructApplicationEvent for this application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5352 + + PostConstructApplicationEvent + + jakarta.faces.event.PostConstructApplicationEvent.PostConstructApplicationEvent +
+ ( + FacesContext + , +
+ Application + ) +
+
+ Constructs a new PostConstructApplicationEvent for this application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5353 + + ScopeContext + + jakarta.faces.event.PostConstructCustomScopeEvent.getContext +
+
+
+ Return the ScopeContext for this event. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5354 + + PostConstructCustomScopeEvent + + jakarta.faces.event.PostConstructCustomScopeEvent.PostConstructCustomScopeEvent +
+ ( + ScopeContext + ) +
+
+ An instance of this event indicates that the custom scope enclosed within the argument + scopeContext was just created. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5355 + + PostConstructCustomScopeEvent + + jakarta.faces.event.PostConstructCustomScopeEvent.PostConstructCustomScopeEvent +
+ ( + FacesContext + , +
+ ScopeContext + ) +
+
+ An instance of this event indicates that the custom scope enclosed within the argument + scopeContext was just created. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5356 + + PostConstructViewMapEvent + + jakarta.faces.event.PostConstructViewMapEvent.PostConstructViewMapEvent +
+ ( + UIViewRoot + ) +
+
+ Instantiate a new PostConstructViewMapEvent that indicates the argument root was just + associated with its view map. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5357 + + PostConstructViewMapEvent + + jakarta.faces.event.PostConstructViewMapEvent.PostConstructViewMapEvent +
+ ( + FacesContext + , +
+ UIViewRoot + ) +
+
+ Instantiate a new PostConstructViewMapEvent that indicates the argument root was just + associated with its view map. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5358 + + String + + jakarta.faces.event.PostKeepFlashValueEvent.getKey +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5359 + + PostKeepFlashValueEvent + + jakarta.faces.event.PostKeepFlashValueEvent.PostKeepFlashValueEvent +
+ ( + String + ) +
+
+ Instantiate a new PostKeepFlashValueEvent that indicates the argument key was just kept + in the flash. If the argument is null, the literal Flash#NULL_VALUE must be passed to the superclass + constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5360 + + PostKeepFlashValueEvent + + jakarta.faces.event.PostKeepFlashValueEvent.PostKeepFlashValueEvent +
+ ( + FacesContext + , +
+ String + ) +
+
+ Instantiate a new PostKeepFlashValueEvent that indicates the argument key was just kept + in the flash. If the argument is null, the literal Flash#NULL_VALUE must be passed to the superclass + constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5361 + + String + + jakarta.faces.event.PostPutFlashValueEvent.getKey +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5362 + + PostPutFlashValueEvent + + jakarta.faces.event.PostPutFlashValueEvent.PostPutFlashValueEvent +
+ ( + String + ) +
+
+ Instantiate a new PostPutFlashValueEvent that indicates the argument key was just put + to the flash. If the argument is null, the literal Flash#NULL_VALUE must be passed to the superclass + constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5363 + + PostPutFlashValueEvent + + jakarta.faces.event.PostPutFlashValueEvent.PostPutFlashValueEvent +
+ ( + FacesContext + , +
+ String + ) +
+
+ Instantiate a new PostPutFlashValueEvent that indicates the argument key was just put + to the flash. If the argument is null, the literal Flash#NULL_VALUE must be passed to the superclass + constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5364 + + PostRenderViewEvent + + jakarta.faces.event.PostRenderViewEvent.PostRenderViewEvent +
+ ( + UIViewRoot + ) +
+
+ Instantiate a new PostRenderViewEvent that indicates the argument root has just been + rendered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5365 + + PostRenderViewEvent + + jakarta.faces.event.PostRenderViewEvent.PostRenderViewEvent +
+ ( + FacesContext + , +
+ UIViewRoot + ) +
+
+ Instantiate a new PostRenderViewEvent that indicates the argument root has just been + rendered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5366 + + PostRestoreStateEvent + + jakarta.faces.event.PostRestoreStateEvent.PostRestoreStateEvent +
+ ( + UIComponent + ) +
+
+ Instantiate a new PostRestoreStateEvent that indicates the argument component just had + its state restored. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5367 + + PostRestoreStateEvent + + jakarta.faces.event.PostRestoreStateEvent.PostRestoreStateEvent +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Instantiate a new PostRestoreStateEvent that indicates the argument component just had + its state restored. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5368 + + void + + jakarta.faces.event.PostRestoreStateEvent.setComponent +
+ ( + UIComponent + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5369 + + PostValidateEvent + + jakarta.faces.event.PostValidateEvent.PostValidateEvent +
+ ( + UIComponent + ) +
+
+ Constructor + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5370 + + PostValidateEvent + + jakarta.faces.event.PostValidateEvent.PostValidateEvent +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Constructor + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5371 + + PreClearFlashEvent + + jakarta.faces.event.PreClearFlashEvent.PreClearFlashEvent +
+ ( + Map + ) +
+
+ Instantiate a new PreClearFlashEvent that indicates the argument key was just put to + the flash. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5372 + + PreClearFlashEvent + + jakarta.faces.event.PreClearFlashEvent.PreClearFlashEvent +
+ ( + FacesContext + , +
+ Map + ) +
+
+ Instantiate a new PreClearFlashEvent that indicates the argument key was just put to + the flash. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5373 + + Application + + jakarta.faces.event.PreDestroyApplicationEvent.getApplication +
+
+
+ The source Application that sent this event. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5374 + + PreDestroyApplicationEvent + + jakarta.faces.event.PreDestroyApplicationEvent.PreDestroyApplicationEvent +
+ ( + Application + ) +
+
+ Constructs a new PreDestroyApplicationEvent for this application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5375 + + PreDestroyApplicationEvent + + jakarta.faces.event.PreDestroyApplicationEvent.PreDestroyApplicationEvent +
+ ( + FacesContext + , +
+ Application + ) +
+
+ Constructs a new PreDestroyApplicationEvent for this application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5376 + + ScopeContext + + jakarta.faces.event.PreDestroyCustomScopeEvent.getContext +
+
+
+ Return the ScopeContext for this event. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5377 + + PreDestroyCustomScopeEvent + + jakarta.faces.event.PreDestroyCustomScopeEvent.PreDestroyCustomScopeEvent +
+ ( + ScopeContext + ) +
+
+ An instance of this event indicates that the custom scope enclosed within the argument + scopeContext is about to end. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5378 + + PreDestroyCustomScopeEvent + + jakarta.faces.event.PreDestroyCustomScopeEvent.PreDestroyCustomScopeEvent +
+ ( + FacesContext + , +
+ ScopeContext + ) +
+
+ An instance of this event indicates that the custom scope enclosed within the argument + scopeContext is about to end. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5379 + + PreDestroyViewMapEvent + + jakarta.faces.event.PreDestroyViewMapEvent.PreDestroyViewMapEvent +
+ ( + UIViewRoot + ) +
+
+ Instantiate a new ViewMapDestroydEvent that indicates the argument root just had its + associated view map destroyed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5380 + + PreDestroyViewMapEvent + + jakarta.faces.event.PreDestroyViewMapEvent.PreDestroyViewMapEvent +
+ ( + FacesContext + , +
+ UIViewRoot + ) +
+
+ Instantiate a new ViewMapDestroydEvent that indicates the argument root just had its + associated view map destroyed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5381 + + String + + jakarta.faces.event.PreRemoveFlashValueEvent.getKey +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5382 + + PreRemoveFlashValueEvent + + jakarta.faces.event.PreRemoveFlashValueEvent.PreRemoveFlashValueEvent +
+ ( + String + ) +
+
+ Instantiate a new PreRemoveFlashValueEvent that indicates the argument key will be + removed from the flash. If the argument is null, the literal Flash#NULL_VALUE must be passed to the + superclass constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5383 + + PreRemoveFlashValueEvent + + jakarta.faces.event.PreRemoveFlashValueEvent.PreRemoveFlashValueEvent +
+ ( + FacesContext + , +
+ String + ) +
+
+ Instantiate a new PreRemoveFlashValueEvent that indicates the argument key will be + removed from the flash. If the argument is null, the literal Flash#NULL_VALUE must be passed to the + superclass constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5384 + + boolean + + jakarta.faces.event.PreRemoveFromViewEvent.isAppropriateListener +
+ ( + FacesListener + ) +
+
+ Returns true if and only if the argument listener is an instance of + SystemEventListener. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5385 + + PreRemoveFromViewEvent + + jakarta.faces.event.PreRemoveFromViewEvent.PreRemoveFromViewEvent +
+ ( + UIComponent + ) +
+
+ Instantiate a new BeforeRemoveFromView that indicates the argument component is about + to be removed from the view. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5386 + + PreRemoveFromViewEvent + + jakarta.faces.event.PreRemoveFromViewEvent.PreRemoveFromViewEvent +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Instantiate a new BeforeRemoveFromView that indicates the argument component is about + to be removed from the view. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5387 + + PreRenderComponentEvent + + jakarta.faces.event.PreRenderComponentEvent.PreRenderComponentEvent +
+ ( + UIComponent + ) +
+
+ Instantiate a new PreRenderComponentEvent that indicates the argument component is + about to be rendered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5388 + + PreRenderComponentEvent + + jakarta.faces.event.PreRenderComponentEvent.PreRenderComponentEvent +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Instantiate a new PreRenderComponentEvent that indicates the argument component is + about to be rendered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5389 + + PreRenderViewEvent + + jakarta.faces.event.PreRenderViewEvent.PreRenderViewEvent +
+ ( + UIViewRoot + ) +
+
+ Instantiate a new PreRenderViewEvent that indicates the argument root is about to be + rendered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5390 + + PreRenderViewEvent + + jakarta.faces.event.PreRenderViewEvent.PreRenderViewEvent +
+ ( + FacesContext + , +
+ UIViewRoot + ) +
+
+ Instantiate a new PreRenderViewEvent that indicates the argument root is about to be + rendered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5391 + + PreValidateEvent + + jakarta.faces.event.PreValidateEvent.PreValidateEvent +
+ ( + UIComponent + ) +
+
+ Constructor + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5392 + + PreValidateEvent + + jakarta.faces.event.PreValidateEvent.PreValidateEvent +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Constructor + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5393 + + Map + + jakarta.faces.event.ScopeContext.getScope +
+
+
+ Return the scope itself, exposed as a Map. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5394 + + String + + jakarta.faces.event.ScopeContext.getScopeName +
+
+
+ Return the name of this custom scope. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5395 + + ScopeContext + + jakarta.faces.event.ScopeContext.ScopeContext +
+ ( + String + , +
+ Map + ) +
+
+ Construct this structure with the supplied arguments. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5396 + + FacesContext + + jakarta.faces.event.SystemEvent.getFacesContext +
+
+
+ Get the Faces context. If the constructor was passed a FacesContext we return it, + otherwise we call FacesContext.getCurrentInstance() and return it. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5397 + + boolean + + jakarta.faces.event.SystemEvent.isAppropriateListener +
+ ( + FacesListener + ) +
+
+ Return true if this FacesListener is an instance of a the appropriate listener class + that this event supports. The default implementation returns true if the listener is a + ComponentSystemEventListener. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5398 + + void + + jakarta.faces.event.SystemEvent.processListener +
+ ( + FacesListener + ) +
+
+ Broadcast this event instance to the specified FacesListener, by whatever mechanism is + appropriate. Typically, this will be accomplished by calling an event processing method, and passing + this instance as a parameter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5399 + + SystemEvent + + jakarta.faces.event.SystemEvent.SystemEvent +
+ ( + Object + ) +
+
+ Pass the argument source to the superclass constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5400 + + SystemEvent + + jakarta.faces.event.SystemEvent.SystemEvent +
+ ( + FacesContext + , +
+ Object + ) +
+
+ Pass the argument source to the superclass constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5401 + + boolean + + jakarta.faces.event.SystemEventListener.isListenerForSource +
+ ( + Object + ) +
+
+ This method must return true if and only if this listener instance is interested in + receiving events from the instance referenced by the source parameter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5402 + + void + + jakarta.faces.event.SystemEventListener.processEvent +
+ ( + SystemEvent + ) +
+
+ When called, the listener can assume that any guarantees given in the javadoc for the + specific SystemEvent subclass are true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5403 + + void + + jakarta.faces.event.SystemEventListener.processEvent +
+ ( + SystemEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ if lifecycle processing should cease for this request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5404 + + List + + jakarta.faces.event.SystemEventListenerHolder.getListenersForEventClass +
+ ( + Class + ) +
+
+ Return a List of SystemEventListener instances that have been installed into the class + implementing this interface. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5405 + + Object + + jakarta.faces.event.ValueChangeEvent.getNewValue +
+
+
+ Return the current local value of the source UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5406 + + Object + + jakarta.faces.event.ValueChangeEvent.getOldValue +
+
+
+ Return the previous local value of the source UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5407 + + boolean + + jakarta.faces.event.ValueChangeEvent.isAppropriateListener +
+ ( + FacesListener + ) +
+
+ Return true if this FacesListener is an instance of a listener class that this event + supports. Typically, this will be accomplished by an "instanceof" check on the listener class. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5408 + + void + + jakarta.faces.event.ValueChangeEvent.processListener +
+ ( + FacesListener + ) +
+
+ Broadcast this FacesEvent to the specified FacesListener, by whatever mechanism is + appropriate. Typically, this will be accomplished by calling an event processing method, and passing + this FacesEvent as a paramter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5409 + + ValueChangeEvent + + jakarta.faces.event.ValueChangeEvent.ValueChangeEvent +
+ ( + UIComponent + , +
+ Object + , +
+ Object + ) +
+
+ Construct a new event object from the specified source component, old value, and new + value. The default PhaseId for this event is PhaseId#ANY_PHASE. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5410 + + ValueChangeEvent + + jakarta.faces.event.ValueChangeEvent.ValueChangeEvent +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + , +
+ Object + ) +
+
+ Construct a new event object from the Faces context, specified source component, old + value and new value. The default PhaseId for this event is PhaseId#ANY_PHASE. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5411 + + void + + jakarta.faces.event.ValueChangeListener.processValueChange +
+ ( + ValueChangeEvent + ) +
+
+ Invoked when the value change described by the specified ValueChangeEvent occurs. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5412 + + void + + jakarta.faces.event.ValueChangeListener.processValueChange +
+ ( + ValueChangeEvent + ) + +
+ throws + AbortProcessingException +
+
+
+ Signal the Jakarta Faces implementation that no further processing on the current event + should be performed + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5413 + + boolean + + jakarta.faces.event.WebsocketEvent.equals +
+ ( + Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5414 + + String + + jakarta.faces.event.WebsocketEvent.getChannel +
+
+
+ Returns the . + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5415 + + CloseCode + + jakarta.faces.event.WebsocketEvent.getCloseCode +
+
+
+ Returns the close code. If this returns null, then it was Opened. If this returns + non-null, then it was Closed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5416 + + Serializable + + jakarta.faces.event.WebsocketEvent.getUser +
+
+
+ Returns the , if any. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5417 + + int + + jakarta.faces.event.WebsocketEvent.hashCode +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5418 + + String + + jakarta.faces.event.WebsocketEvent.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5419 + + WebsocketEvent + + jakarta.faces.event.WebsocketEvent.WebsocketEvent +
+ ( + String + , +
+ Serializable + , +
+ CloseCode + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5420 + + Literal + + jakarta.faces.event.WebsocketEvent.Closed.Literal.WebsocketEvent.Closed.Literal +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5421 + + Literal + + jakarta.faces.event.WebsocketEvent.Opened.Literal.WebsocketEvent.Opened.Literal +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5422 + + Flow + + jakarta.faces.flow.Flow.Flow +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5423 + + String + + jakarta.faces.flow.Flow.getClientWindowFlowId +
+ ( + ClientWindow + ) +
+
+ Get the ClientWindow's id and append "_" and the return from #getId. Return the result. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5424 + + String + + jakarta.faces.flow.Flow.getDefiningDocumentId +
+
+
+ Return the immutable application unique identifier for the document in which the + argument flow is defined. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5425 + + MethodExpression + + jakarta.faces.flow.Flow.getFinalizer +
+
+
+ Return the MethodExpression that must be called by the runtime as the last thing that + happens before exiting this flow. Any FlowScoped beans declared for this flow must remain in scope + until after control returns from the method referenced by this MethodExpression. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5426 + + FlowCallNode + + jakarta.faces.flow.Flow.getFlowCall +
+ ( + Flow + ) +
+
+ Return the FlowCallNode that represents calling the targetFlow from this flow, or null + if targetFlow cannot be reached from this flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5427 + + Map + + jakarta.faces.flow.Flow.getFlowCalls +
+
+
+ Return an immutable data structure containing all the flow call nodes declared for this + flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5428 + + String + + jakarta.faces.flow.Flow.getId +
+
+
+ Return the immutable id for this Flow. This must be unique within the defining document + (such as an Application Configuration Resources file), but need not be unique within the entire + application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5429 + + Map + + jakarta.faces.flow.Flow.getInboundParameters +
+
+
+ Return an immutable data structure containing the inbound parameters that have been + declared for this flow. See FlowHandler#transition for the specification of how these parameters are + used. Inbound parameters are associated with a specific flow instance, while outbound parameters are + associated with a FlowCallNode that causes the transition to a new flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5430 + + MethodExpression + + jakarta.faces.flow.Flow.getInitializer +
+
+
+ Return the MethodExpression that must be called by the runtime immediately after + activating any FlowScoped beans declared for this flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5431 + + List + + jakarta.faces.flow.Flow.getMethodCalls +
+
+
+ Return an immutable data structure containing all the method call nodes declared for + this flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5432 + + Map + + jakarta.faces.flow.Flow.getNavigationCases +
+
+
+ Return an unmodifiable view of the navigation cases within this flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5433 + + FlowNode + + jakarta.faces.flow.Flow.getNode +
+ ( + String + ) +
+
+ Return the generic FlowNode by id, or null if not found. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5434 + + Map + + jakarta.faces.flow.Flow.getReturns +
+
+
+ Return an immutable data structure containing all of the return nodes declared for this + flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5435 + + String + + jakarta.faces.flow.Flow.getStartNodeId +
+
+
+ Return the immutable id for the default node that should be activated when this flow is + entered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5436 + + Map + + jakarta.faces.flow.Flow.getSwitches +
+
+
+ Return an immutable data structure containing all of the switch nodes declared for this + flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5437 + + List + + jakarta.faces.flow.Flow.getViews +
+
+
+ Return an immutable data structure containing all of the view nodes declared for this + flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5438 + + FlowCallNode + + jakarta.faces.flow.FlowCallNode.FlowCallNode +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5439 + + String + + jakarta.faces.flow.FlowCallNode.getCalledFlowDocumentId +
+ ( + FacesContext + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5440 + + String + + jakarta.faces.flow.FlowCallNode.getCalledFlowId +
+ ( + FacesContext + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5441 + + Map + + jakarta.faces.flow.FlowCallNode.getOutboundParameters +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5442 + + void + + jakarta.faces.flow.FlowHandler.addFlow +
+ ( + FacesContext + , +
+ Flow + ) +
+
+ Add the argument Flow to the collection of Flows known to the current application. The + implementation must be thread safe. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5443 + + void + + jakarta.faces.flow.FlowHandler.clientWindowTransition +
+ ( + FacesContext + ) +
+
+ Allow for flow transitions in the case of components rendered by the renderers from + component-family jakarta.faces.OutcomeTarget. These transitions must happen at the front of the + request processing lifecycle due to the HTTP GET based nature of such components. Therefore, this + method is called from the restore view phase of the lifecycle. Let flowId be the value in the + request parameter map for the parameter whose name is given by the value of + #FLOW_ID_REQUEST_PARAM_NAME. Let toFlowDocumentId be the value in the request parameter map for the + paramater whose name is given by the value of #TO_FLOW_DOCUMENT_ID_REQUEST_PARAM_NAME. If + toFlowDocumentId is null, take no action and return. Otherwise, let sourceFlow be the return from + #getCurrentFlow(jakarta.faces.context.FacesContext). A null value indicates there is no current + flow, which will be the case if this navigation is trying to enter a flow. If flowId is not null and + toFlowDocumentId is not equal to the value of #NULL_FLOW, let targetFlow be the result of calling + #getFlow(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String), passing + toFlowDocumentId and flowId as the last two arguments, respectively. If the result is non-null, let + flowCallNode be the return from calling Flow#getFlowCall on the sourceFlow, passing targetFlow as + the argument. Otherwise, targetFlow and flowCallNode must remain null, indicating that this is a + flow return. Call FacesContext#getViewRoot() and let toViewId be the the return from calling + jakarta.faces.component.UIViewRoot#getViewId on it. Call, #transition, passing the arguments + gathered in the preceding algorithm. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5444 + + FlowHandler + + jakarta.faces.flow.FlowHandler.FlowHandler +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5445 + + Flow + + jakarta.faces.flow.FlowHandler.getCurrentFlow +
+ ( + FacesContext + ) +
+
+ Return the currently active Flow for the argument FacesContext, or null if no flow is + active. A Flow must always be associated with exactly one jakarta.faces.lifecycle.ClientWindow, but + a ClientWindow may have multiple Flows. If #pushReturnMode had been called with true as the argument + before invoking this method, return the preceding flow on the stack instead of the actual current + flow, or null if there is no preceding flow. Otherwise, return the current flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5446 + + Flow + + jakarta.faces.flow.FlowHandler.getCurrentFlow +
+
+
+ Convenience overload that calls FacesContext#getCurrentInstance() and then calls + through to #getCurrentFlow(jakarta.faces.context.FacesContext). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5447 + + Map + + jakarta.faces.flow.FlowHandler.getCurrentFlowScope +
+
+
+ Return the Map that backs the #{flowScope} Jakarta Expression Language implicit object + or null if no flow is currently active. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5448 + + Flow + + jakarta.faces.flow.FlowHandler.getFlow +
+ ( + FacesContext + , +
+ String + , +
+ String + ) +
+
+ Return the Flow whose id is equivalent to the argument id, within the scope of the + argument definingDocument. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5449 + + String + + jakarta.faces.flow.FlowHandler.getLastDisplayedViewId +
+ ( + FacesContext + ) +
+
+ Return the last displayed viewId for the current flow, as returned by + #getCurrentFlow(jakarta.faces.context.FacesContext), or null if there is no current flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5450 + + boolean + + jakarta.faces.flow.FlowHandler.isActive +
+ ( + FacesContext + , +
+ String + , +
+ String + ) +
+
+ Return true if and only if the flow referenced by the argument definingDocument and id + is currently active. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5451 + + void + + jakarta.faces.flow.FlowHandler.popReturnMode +
+ ( + FacesContext + ) +
+
+ Enable the correct handling of navigation when processing a return node. The default + jakarta.faces.application.NavigationHandler specification requires calling this method from a + finally block, immediately attempting to process the navigation rules in the context of a flow + return. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5452 + + void + + jakarta.faces.flow.FlowHandler.pushReturnMode +
+ ( + FacesContext + ) +
+
+ Enable the correct handling of navigation when processing a return node. The default + jakarta.faces.application.NavigationHandler specification requires calling this method before + processing the navigation rules for the flow return, and calling #popReturnMode, from a finally + block, immediately afterward. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5453 + + void + + jakarta.faces.flow.FlowHandler.transition +
+ ( + FacesContext + , +
+ Flow + , +
+ Flow + , +
+ FlowCallNode + , +
+ String + ) +
+
+ Perform a transition in the flow graph for the current user's + jakarta.faces.lifecycle.ClientWindow. Obtain references to the Flow instances corresponding to the + origin and destination arguments. If the origin Flow is equal to the destination Flow, take no + action and return null. Otherwise, if the outboundCallNode argument is non-null save aside the + outbound parameters. For discussion evaluatedParams is a data structure that stores the evaluated + values of any outbound parameters. It is necessary to evaluate these values before popping any flow + scopes because the values may refer to scoped instances that need to be passed to the target flow, + but will not be available once the new scope is activated. Save aside the outbound parameters using + the following algorithm. If the outboundParameters property of outboundCallNode is non-null and not + empty, and the inboundParameters property of the target flow is non-null and not empty, for each + entry in the outbound parameters whose name matches an entry in the inbound parameters, evaluate the + value of the parameter, and put the evaluated value into evaluatedParams under the corresponding + name. Otherwise, consider evaluatedParams to be empty. If the destination Flow is a sub-flow of the + origin Flow push the destination Flow onto the flow data structure and return the destination Flow. + Otherwise, pop the current Flow from the flow data structure. If the destination Flow is non-null, + make the destination Flow the current flow, pushing it onto the data structure. If evaluatedParams + is not empty, for each entry, find the corresponding parameter in the target flow's inbound + parameters and call its setValue method, passing the value from evaluatedParams. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5454 + + FlowHandler + + jakarta.faces.flow.FlowHandlerFactory.createFlowHandler +
+ ( + FacesContext + ) +
+
+ Create the singleton instance of FlowHandler. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5455 + + FlowHandlerFactory + + jakarta.faces.flow.FlowHandlerFactory.FlowHandlerFactory +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5456 + + FlowHandler + + jakarta.faces.flow.FlowHandlerFactoryWrapper.createFlowHandler +
+ ( + FacesContext + ) +
+
+ Create the singleton instance of FlowHandler. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5457 + + FlowHandlerFactoryWrapper + + jakarta.faces.flow.FlowHandlerFactoryWrapper.FlowHandlerFactoryWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:5458 + + FlowHandlerFactoryWrapper + + jakarta.faces.flow.FlowHandlerFactoryWrapper.FlowHandlerFactoryWrapper +
+ ( + FlowHandlerFactory + ) +
+
+ If this flow handler factory has been decorated, the implementation doing the + decorating should push the implementation being wrapped to this constructor. The #getWrapped() will + then return the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5459 + + FlowHandlerFactory + + jakarta.faces.flow.FlowHandlerFactoryWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5460 + + FlowNode + + jakarta.faces.flow.FlowNode.FlowNode +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5461 + + String + + jakarta.faces.flow.FlowNode.getId +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5462 + + String + + jakarta.faces.flow.FlowScoped.definingDocumentId +
+
+
+ If not empty, declare the defining document id within which the Flow referenced by + #value is unique. If empty the, the runtime assumes that all flow ids are unique within the scope of + the application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5463 + + String + + jakarta.faces.flow.FlowScoped.value +
+
+
+ Must be equivalent to the Flow#getId of a defined flow for this application. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5464 + + MethodExpression + + jakarta.faces.flow.MethodCallNode.getMethodExpression +
+
+
+ Return the MethodExpression to be invoked to when control passes to this node. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5465 + + ValueExpression + + jakarta.faces.flow.MethodCallNode.getOutcome +
+
+
+ Return the outcome to be used in the event of a null return from the method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5466 + + List + + jakarta.faces.flow.MethodCallNode.getParameters +
+
+
+ Return the parameters to be passed to the method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5467 + + MethodCallNode + + jakarta.faces.flow.MethodCallNode.MethodCallNode +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5468 + + String + + jakarta.faces.flow.Parameter.getName +
+
+
+ Return the name of the parameter + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5469 + + ValueExpression + + jakarta.faces.flow.Parameter.getValue +
+
+
+ Return a ValueExpression for the value of the parameter. Depending on the context, this + expression may only ever be evaluated in a "get" operation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5470 + + Parameter + + jakarta.faces.flow.Parameter.Parameter +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5471 + + String + + jakarta.faces.flow.ReturnNode.getFromOutcome +
+ ( + FacesContext + ) +
+
+ Return the fromOutcome to be used when control passes to this return node. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5472 + + ReturnNode + + jakarta.faces.flow.ReturnNode.ReturnNode +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5473 + + Boolean + + jakarta.faces.flow.SwitchCase.getCondition +
+ ( + FacesContext + ) +
+
+ Return true if this case should be taken, false otherwise. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5474 + + String + + jakarta.faces.flow.SwitchCase.getFromOutcome +
+
+
+ Return the outcome to be used if #getCondition return true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5475 + + SwitchCase + + jakarta.faces.flow.SwitchCase.SwitchCase +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5476 + + List + + jakarta.faces.flow.SwitchNode.getCases +
+
+
+ Return the cases in this switch. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5477 + + String + + jakarta.faces.flow.SwitchNode.getDefaultOutcome +
+ ( + FacesContext + ) +
+
+ Return the default outcome in this switch. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5478 + + SwitchNode + + jakarta.faces.flow.SwitchNode.SwitchNode +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5479 + + String + + jakarta.faces.flow.ViewNode.getVdlDocumentId +
+
+
+ Return the immutable VDL document id for this view node. This is normally the path to + the VDL page that defines this view node. This must be unique within the flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5480 + + ViewNode + + jakarta.faces.flow.ViewNode.ViewNode +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5481 + + FlowBuilder + + jakarta.faces.flow.builder.FlowBuilder.finalizer +
+ ( + MethodExpression + ) +
+
+ A MethodExpression that will be invoked when the flow is exited. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5482 + + FlowBuilder + + jakarta.faces.flow.builder.FlowBuilder.finalizer +
+ ( + String + ) +
+
+ A MethodExpression that will be invoked when the flow is exited. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5483 + + FlowBuilder + + jakarta.faces.flow.builder.FlowBuilder.FlowBuilder +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5484 + + FlowCallBuilder + + jakarta.faces.flow.builder.FlowBuilder.flowCallNode +
+ ( + String + ) +
+
+ Define a flow call node. This node will cause the specified flow to be called, passing + parameters if necessary. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5485 + + Flow + + jakarta.faces.flow.builder.FlowBuilder.getFlow +
+
+
+ Called as the last step in flow definition, this method must perform any implementation + specific initialization and return the built Flow. If called more than one time during a given flow + building process, the second and subsequent invocations must take no action and return the built + flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5486 + + FlowBuilder + + jakarta.faces.flow.builder.FlowBuilder.id +
+ ( + String + , +
+ String + ) +
+
+ Set the defining document id and flow id of this flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5487 + + FlowBuilder + + jakarta.faces.flow.builder.FlowBuilder.inboundParameter +
+ ( + String + , +
+ ValueExpression + ) +
+
+ A parameter that will be populated with the value from a correspondingly named outbound + parameter from another flow when this flow is entered from that flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5488 + + FlowBuilder + + jakarta.faces.flow.builder.FlowBuilder.inboundParameter +
+ ( + String + , +
+ String + ) +
+
+ A parameter that will be populated with the value from a correspondingly named outbound + parameter from another flow when this flow is entered from that flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5489 + + FlowBuilder + + jakarta.faces.flow.builder.FlowBuilder.initializer +
+ ( + MethodExpression + ) +
+
+ A MethodExpression that will be invoked when the flow is entered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5490 + + FlowBuilder + + jakarta.faces.flow.builder.FlowBuilder.initializer +
+ ( + String + ) +
+
+ A MethodExpression that will be invoked when the flow is entered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5491 + + MethodCallBuilder + + jakarta.faces.flow.builder.FlowBuilder.methodCallNode +
+ ( + String + ) +
+
+ Define a method call node. This node will cause the specified method to be invoked, + passing parameters if necessary. The return from the method is used as the outcome for where to go + next in the flow. If the method is a void method, the default outcome is used. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5492 + + NavigationCaseBuilder + + jakarta.faces.flow.builder.FlowBuilder.navigationCase +
+
+
+ Define a particular combination of conditions that must match for this case to be + executed, and the view id of the component tree that should be selected next. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5493 + + ReturnBuilder + + jakarta.faces.flow.builder.FlowBuilder.returnNode +
+ ( + String + ) +
+
+ Define a return node. This node will cause the specified outcome to be returned to the + calling flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5494 + + SwitchBuilder + + jakarta.faces.flow.builder.FlowBuilder.switchNode +
+ ( + String + ) +
+
+ Define a particular list of cases that will be inspected in the order they are defined + to determine where to go next in the flow graph. If none of the cases match, the outcome from the + default case is chosen. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5495 + + ViewBuilder + + jakarta.faces.flow.builder.FlowBuilder.viewNode +
+ ( + String + , +
+ String + ) +
+
+ Define a view node in a flow graph. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5496 + + Literal + + jakarta.faces.flow.builder.FlowBuilderParameter.Literal.FlowBuilderParameter.Literal +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5497 + + FlowCallBuilder + + jakarta.faces.flow.builder.FlowCallBuilder.FlowCallBuilder +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5498 + + FlowCallBuilder + + jakarta.faces.flow.builder.FlowCallBuilder.flowReference +
+ ( + String + , +
+ String + ) +
+
+ Define the flow reference of the called flow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5499 + + FlowCallBuilder + + jakarta.faces.flow.builder.FlowCallBuilder.markAsStartNode +
+
+
+ Mark this node as the start node in the flow. Any other node that had been marked as + the start node will no longer be the start node. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5500 + + FlowCallBuilder + + jakarta.faces.flow.builder.FlowCallBuilder.outboundParameter +
+ ( + String + , +
+ ValueExpression + ) +
+
+ Define an outbound parameter for the flow call. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5501 + + FlowCallBuilder + + jakarta.faces.flow.builder.FlowCallBuilder.outboundParameter +
+ ( + String + , +
+ String + ) +
+
+ Define an outbound parameter for the flow call. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5502 + + Literal + + jakarta.faces.flow.builder.FlowDefinition.Literal.FlowDefinition.Literal +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5503 + + MethodCallBuilder + + jakarta.faces.flow.builder.MethodCallBuilder.defaultOutcome +
+ ( + String + ) +
+
+ If the method is a void method, or the method returns null, this can be used to specify + what value should be passed to runtime when the method returns. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5504 + + MethodCallBuilder + + jakarta.faces.flow.builder.MethodCallBuilder.defaultOutcome +
+ ( + ValueExpression + ) +
+
+ If the method is a void method, or the method returns null, this can be used to specify + what value should be passed to runtime when the method returns. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5505 + + MethodCallBuilder + + jakarta.faces.flow.builder.MethodCallBuilder.expression +
+ ( + MethodExpression + ) +
+
+ Set the method expression of this method call node. The method signature of the + argument methodExpression must match the number and type of the parameters passed in the #parameters + method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5506 + + MethodCallBuilder + + jakarta.faces.flow.builder.MethodCallBuilder.expression +
+ ( + String + ) +
+
+ Set the method expression of this method call node. The method signature of the + argument methodExpression must match the number and type of the parameters passed in the #parameters + method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5507 + + MethodCallBuilder + + jakarta.faces.flow.builder.MethodCallBuilder.expression +
+ ( + String + , +
+ Class[] + ) +
+
+ Set the method expression of this method call node. The method signature of the + argument methodExpression must match the number and type of the parameters passed in the #parameters + method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5508 + + MethodCallBuilder + + jakarta.faces.flow.builder.MethodCallBuilder.markAsStartNode +
+
+
+ Mark this node as the start node in the flow. Any other node that had been marked as + the start node will no longer be the start node. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5509 + + MethodCallBuilder + + jakarta.faces.flow.builder.MethodCallBuilder.MethodCallBuilder +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5510 + + MethodCallBuilder + + jakarta.faces.flow.builder.MethodCallBuilder.parameters +
+ ( + List + ) +
+
+ Set the parameters of the method call node. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5511 + + NavigationCaseBuilder + + jakarta.faces.flow.builder.NavigationCaseBuilder.condition +
+ ( + String + ) +
+
+ Set the if of the current navigation case. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5512 + + NavigationCaseBuilder + + jakarta.faces.flow.builder.NavigationCaseBuilder.condition +
+ ( + ValueExpression + ) +
+
+ Set the if of the current navigation case. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5513 + + NavigationCaseBuilder + + jakarta.faces.flow.builder.NavigationCaseBuilder.fromAction +
+ ( + String + ) +
+
+ Set the from-action of the current navigation case. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5514 + + NavigationCaseBuilder + + jakarta.faces.flow.builder.NavigationCaseBuilder.fromOutcome +
+ ( + String + ) +
+
+ Set the from-outcome of the current navigation case. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5515 + + NavigationCaseBuilder + + jakarta.faces.flow.builder.NavigationCaseBuilder.fromViewId +
+ ( + String + ) +
+
+ Set the from-view-id of the current navigation case. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5516 + + NavigationCaseBuilder + + jakarta.faces.flow.builder.NavigationCaseBuilder.NavigationCaseBuilder +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5517 + + RedirectBuilder + + jakarta.faces.flow.builder.NavigationCaseBuilder.redirect +
+
+
+ Create a redirect within this navigation case. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5518 + + NavigationCaseBuilder + + jakarta.faces.flow.builder.NavigationCaseBuilder.toFlowDocumentId +
+ ( + String + ) +
+
+ Set the to-flow-document-id of the current navigation case. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5519 + + NavigationCaseBuilder + + jakarta.faces.flow.builder.NavigationCaseBuilder.toViewId +
+ ( + String + ) +
+
+ Set the to-view-id of the current navigation case. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5520 + + RedirectBuilder + + jakarta.faces.flow.builder.NavigationCaseBuilder.RedirectBuilder.includeViewParams +
+
+
+ Indicates the current redirect should include view parameters. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5521 + + RedirectBuilder + + + jakarta.faces.flow.builder.NavigationCaseBuilder.RedirectBuilder.NavigationCaseBuilder.RedirectBuilder +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5522 + + RedirectBuilder + + jakarta.faces.flow.builder.NavigationCaseBuilder.RedirectBuilder.parameter +
+ ( + String + , +
+ String + ) +
+
+ Add a parameter to the redirect. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5523 + + NodeBuilder + + jakarta.faces.flow.builder.NodeBuilder.markAsStartNode +
+
+
+ Mark this node as the start node in the flow. Any other node that had been marked as + the start node will no longer be the start node. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5524 + + ReturnBuilder + + jakarta.faces.flow.builder.ReturnBuilder.fromOutcome +
+ ( + String + ) +
+
+ Set the outcome of the current return node. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5525 + + ReturnBuilder + + jakarta.faces.flow.builder.ReturnBuilder.fromOutcome +
+ ( + ValueExpression + ) +
+
+ Set the outcome of the current return node. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5526 + + ReturnBuilder + + jakarta.faces.flow.builder.ReturnBuilder.markAsStartNode +
+
+
+ Mark this node as the start node in the flow. Any other node that had been marked as + the start node will no longer be the start node. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5527 + + ReturnBuilder + + jakarta.faces.flow.builder.ReturnBuilder.ReturnBuilder +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5528 + + SwitchCaseBuilder + + jakarta.faces.flow.builder.SwitchBuilder.defaultOutcome +
+ ( + String + ) +
+
+ Set the default outcome of the current switch. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5529 + + SwitchCaseBuilder + + jakarta.faces.flow.builder.SwitchBuilder.defaultOutcome +
+ ( + ValueExpression + ) +
+
+ Set the default outcome of the current switch. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5530 + + SwitchBuilder + + jakarta.faces.flow.builder.SwitchBuilder.markAsStartNode +
+
+
+ Mark this node as the start node in the flow. Any other node that had been marked as + the start node will no longer be the start node. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5531 + + SwitchBuilder + + jakarta.faces.flow.builder.SwitchBuilder.SwitchBuilder +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5532 + + SwitchCaseBuilder + + jakarta.faces.flow.builder.SwitchBuilder.switchCase +
+
+
+ Create a switch case in the current switch. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5533 + + SwitchCaseBuilder + + jakarta.faces.flow.builder.SwitchCaseBuilder.condition +
+ ( + ValueExpression + ) +
+
+ Set the if in the previously created switch case. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5534 + + SwitchCaseBuilder + + jakarta.faces.flow.builder.SwitchCaseBuilder.condition +
+ ( + String + ) +
+
+ Set the if in the previously created switch case. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5535 + + SwitchCaseBuilder + + jakarta.faces.flow.builder.SwitchCaseBuilder.fromOutcome +
+ ( + String + ) +
+
+ Set the outcome in the previously created switch case. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5536 + + SwitchCaseBuilder + + jakarta.faces.flow.builder.SwitchCaseBuilder.switchCase +
+
+
+ Create a new case in the current switch. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5537 + + SwitchCaseBuilder + + jakarta.faces.flow.builder.SwitchCaseBuilder.SwitchCaseBuilder +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5538 + + ViewBuilder + + jakarta.faces.flow.builder.ViewBuilder.markAsStartNode +
+
+
+ Mark this node as the start node in the flow. Any other node that had been marked as + the start node will no longer be the start node. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5539 + + ViewBuilder + + jakarta.faces.flow.builder.ViewBuilder.ViewBuilder +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5540 + + ClientWindow + + jakarta.faces.lifecycle.ClientWindow.ClientWindow +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5541 + + void + + jakarta.faces.lifecycle.ClientWindow.decode +
+ ( + FacesContext + ) +
+
+ The implementation is responsible for examining the incoming request and extracting the + value that must be returned from the #getId method. If #CLIENT_WINDOW_MODE_PARAM_NAME is "none" this + method must not be invoked. If #CLIENT_WINDOW_MODE_PARAM_NAME is "url" the implementation must first + look for a request parameter under the name given by the value of + jakarta.faces.render.ResponseStateManager#CLIENT_WINDOW_PARAM. If no value is found, look for a + request parameter under the name given by the value of + jakarta.faces.render.ResponseStateManager#CLIENT_WINDOW_URL_PARAM. If no value is found, fabricate + an id that uniquely identifies this ClientWindow within the scope of the current session. This value + must be made available to return from the #getId method. The value must be suitable for inclusion as + a hidden field or query parameter. If a value is found, decrypt it using the key from the session + and make it available for return from #getId. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5542 + + void + + jakarta.faces.lifecycle.ClientWindow.disableClientWindowRenderMode +
+ ( + FacesContext + ) +
+
+ Components that permit per-use disabling of the appending of the ClientWindow in + generated URLs must call this method first before rendering those URLs. The caller must call + #enableClientWindowRenderMode(jakarta.faces.context.FacesContext) from a finally block after + rendering the URL. If #CLIENT_WINDOW_MODE_PARAM_NAME is "url" without the quotes, all generated URLs + that cause a GET request must append the ClientWindow by default. This is specified as a static + method because callsites need to access it without having access to an actual ClientWindow instance. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5543 + + void + + jakarta.faces.lifecycle.ClientWindow.enableClientWindowRenderMode +
+ ( + FacesContext + ) +
+
+ Components that permit per-use disabling of the appending of the ClientWindow in + generated URLs must call this method first after rendering those URLs. If + #CLIENT_WINDOW_MODE_PARAM_NAME is "url" without the quotes, all generated URLs that cause a GET + request must append the ClientWindow by default. This is specified as a static method because + callsites need to access it without having access to an actual ClientWindow instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5544 + + String + + jakarta.faces.lifecycle.ClientWindow.getId +
+
+
+ Return a String value that uniquely identifies this ClientWindow within the scope of + the current session. See #decode for the specification of how to derive this value. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5545 + + Map + + jakarta.faces.lifecycle.ClientWindow.getQueryURLParameters +
+ ( + FacesContext + ) +
+
+ This method will be called whenever a URL is generated by the runtime where client + window related parameters need to be inserted into the URL. This guarantees custom ClientWindow + implementations that they will have the opportunity to insert any additional client window specific + information in any case where a URL is generated, such as the rendering of hyperlinks. The returned + map must be immutable. The default implementation of this method returns the empty map. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5546 + + boolean + + jakarta.faces.lifecycle.ClientWindow.isClientWindowRenderModeEnabled +
+ ( + FacesContext + ) +
+
+ Methods that append the ClientWindow to generated URLs must call this method to see if + they are permitted to do so. If #CLIENT_WINDOW_MODE_PARAM_NAME is "url" without the quotes, all + generated URLs that cause a GET request must append the ClientWindow by default. This is specified + as a static method because callsites need to access it without having access to an actual + ClientWindow instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5547 + + ClientWindowFactory + + jakarta.faces.lifecycle.ClientWindowFactory.ClientWindowFactory +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:5548 + + ClientWindowFactory + + jakarta.faces.lifecycle.ClientWindowFactory.ClientWindowFactory +
+ ( + ClientWindowFactory + ) +
+
+ If this factory has been decorated, the implementation doing the decorating should push + the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5549 + + ClientWindow + + jakarta.faces.lifecycle.ClientWindowFactory.getClientWindow +
+ ( + FacesContext + ) +
+
+ The implementation is responsible for creating the ClientWindow instance for this + request. If ClientWindow#CLIENT_WINDOW_MODE_PARAM_NAME is "none" or unspecified, this method must + return null. If ClientWindow#CLIENT_WINDOW_MODE_PARAM_NAME is "url" the implementation must return a + ClientWindow instance that implements the url-mode semantics described in ClientWindow. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5550 + + ClientWindowFactory + + jakarta.faces.lifecycle.ClientWindowFactory.getWrapped +
+
+
+ If this factory has been decorated, the implementation doing the decorating may + override this method to provide access to the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5551 + + ClientWindowWrapper + + jakarta.faces.lifecycle.ClientWindowWrapper.ClientWindowWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:5552 + + ClientWindowWrapper + + jakarta.faces.lifecycle.ClientWindowWrapper.ClientWindowWrapper +
+ ( + ClientWindow + ) +
+
+ If this client window has been decorated, the implementation doing the decorating + should push the implementation being wrapped to this constructor. The #getWrapped() will then return + the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5553 + + void + + jakarta.faces.lifecycle.ClientWindowWrapper.decode +
+ ( + FacesContext + ) +
+
+ The implementation is responsible for examining the incoming request and extracting the + value that must be returned from the #getId method. If #CLIENT_WINDOW_MODE_PARAM_NAME is "none" this + method must not be invoked. If #CLIENT_WINDOW_MODE_PARAM_NAME is "url" the implementation must first + look for a request parameter under the name given by the value of + jakarta.faces.render.ResponseStateManager#CLIENT_WINDOW_PARAM. If no value is found, look for a + request parameter under the name given by the value of + jakarta.faces.render.ResponseStateManager#CLIENT_WINDOW_URL_PARAM. If no value is found, fabricate + an id that uniquely identifies this ClientWindow within the scope of the current session. This value + must be made available to return from the #getId method. The value must be suitable for inclusion as + a hidden field or query parameter. If a value is found, decrypt it using the key from the session + and make it available for return from #getId. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5554 + + void + + jakarta.faces.lifecycle.ClientWindowWrapper.disableClientWindowRenderMode +
+ ( + FacesContext + ) +
+
+ Components that permit per-use disabling of the appending of the ClientWindow in + generated URLs must call this method first before rendering those URLs. The caller must call + #enableClientWindowRenderMode(jakarta.faces.context.FacesContext) from a finally block after + rendering the URL. If #CLIENT_WINDOW_MODE_PARAM_NAME is "url" without the quotes, all generated URLs + that cause a GET request must append the ClientWindow by default. This is specified as a static + method because callsites need to access it without having access to an actual ClientWindow instance. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5555 + + void + + jakarta.faces.lifecycle.ClientWindowWrapper.enableClientWindowRenderMode +
+ ( + FacesContext + ) +
+
+ Components that permit per-use disabling of the appending of the ClientWindow in + generated URLs must call this method first after rendering those URLs. If + #CLIENT_WINDOW_MODE_PARAM_NAME is "url" without the quotes, all generated URLs that cause a GET + request must append the ClientWindow by default. This is specified as a static method because + callsites need to access it without having access to an actual ClientWindow instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5556 + + String + + jakarta.faces.lifecycle.ClientWindowWrapper.getId +
+
+
+ Return a String value that uniquely identifies this ClientWindow within the scope of + the current session. See #decode for the specification of how to derive this value. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5557 + + Map + + jakarta.faces.lifecycle.ClientWindowWrapper.getQueryURLParameters +
+ ( + FacesContext + ) +
+
+ This method will be called whenever a URL is generated by the runtime where client + window related parameters need to be inserted into the URL. This guarantees custom ClientWindow + implementations that they will have the opportunity to insert any additional client window specific + information in any case where a URL is generated, such as the rendering of hyperlinks. The returned + map must be immutable. The default implementation of this method returns the empty map. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5558 + + ClientWindow + + jakarta.faces.lifecycle.ClientWindowWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5559 + + boolean + + jakarta.faces.lifecycle.ClientWindowWrapper.isClientWindowRenderModeEnabled +
+ ( + FacesContext + ) +
+
+ Methods that append the ClientWindow to generated URLs must call this method to see if + they are permitted to do so. If #CLIENT_WINDOW_MODE_PARAM_NAME is "url" without the quotes, all + generated URLs that cause a GET request must append the ClientWindow by default. This is specified + as a static method because callsites need to access it without having access to an actual + ClientWindow instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5560 + + void + + jakarta.faces.lifecycle.Lifecycle.addPhaseListener +
+ ( + PhaseListener + ) +
+
+ Register a new PhaseListener instance that is interested in being notified before and + after the processing for standard phases of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5561 + + void + + jakarta.faces.lifecycle.Lifecycle.attachWindow +
+ ( + FacesContext + ) +
+
+ Create or restore the ClientWindow to be used to display the + jakarta.faces.component.UIViewRoot for this run through the lifecycle. See the class documentation + for ClientWindow for an overview of the feature. If + jakarta.faces.context.ExternalContext#getClientWindow() returns null, create a new instance of + ClientWindow using the ClientWindowFactory. If the result is non-null, call + ClientWindow#decode(jakarta.faces.context.FacesContext) on it. Store the new ClientWindow by calling + jakarta.faces.context.ExternalContext#setClientWindow(jakarta.faces.lifecycle.ClientWindow). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5562 + + PhaseListener[] + + jakarta.faces.lifecycle.Lifecycle.getPhaseListeners +
+
+
+ Return the set of registered PhaseListeners for this Lifecycle instance. If there are + no registered listeners, a zero-length array is returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5563 + + void + + jakarta.faces.lifecycle.Lifecycle.removePhaseListener +
+ ( + PhaseListener + ) +
+
+ Deregister an existing PhaseListener instance that is no longer interested in being + notified before and after the processing for standard phases of the request processing lifecycle. If + no such listener instance has been registered, no action is taken. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5564 + + void + + jakarta.faces.lifecycle.Lifecycle.render +
+ ( + FacesContext + ) +
+
+ Execute the Render Response phase of the request processing lifecycle, unless the + responseComplete() method has been called on the FacesContext instance associated with the current + request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5565 + + void + + jakarta.faces.lifecycle.Lifecycle.render +
+ ( + FacesContext + ) + +
+ throws + FacesException +
+
+
+ if an exception is thrown during the execution of the request processing lifecycle + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5566 + + LifecycleFactory + + jakarta.faces.lifecycle.LifecycleFactory.getWrapped +
+
+
+ If this factory has been decorated, the implementation doing the decorating may + override this method to provide access to the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5567 + + LifecycleFactory + + jakarta.faces.lifecycle.LifecycleFactory.LifecycleFactory +
+ ( + LifecycleFactory + ) +
+
+ If this factory has been decorated, the implementation doing the decorating should push + the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5568 + + void + + jakarta.faces.lifecycle.LifecycleWrapper.addPhaseListener +
+ ( + PhaseListener + ) +
+
+ Register a new PhaseListener instance that is interested in being notified before and + after the processing for standard phases of the request processing lifecycle. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5569 + + void + + jakarta.faces.lifecycle.LifecycleWrapper.attachWindow +
+ ( + FacesContext + ) +
+
+ Create or restore the ClientWindow to be used to display the + jakarta.faces.component.UIViewRoot for this run through the lifecycle. See the class documentation + for ClientWindow for an overview of the feature. If + jakarta.faces.context.ExternalContext#getClientWindow() returns null, create a new instance of + ClientWindow using the ClientWindowFactory. If the result is non-null, call + ClientWindow#decode(jakarta.faces.context.FacesContext) on it. Store the new ClientWindow by calling + jakarta.faces.context.ExternalContext#setClientWindow(jakarta.faces.lifecycle.ClientWindow). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5570 + + void + + jakarta.faces.lifecycle.LifecycleWrapper.execute +
+ ( + FacesContext + ) +
+
+ Execute all of the phases of the request processing lifecycle, up to but not including + the Render Response phase, as described in section 2 "Request Processing Lifecycle" of the Jakarta + Faces Specification Document, in the specified order. The processing flow can be affected (by the + application, by components, or by event listeners) by calls to the renderResponse() or + responseComplete() methods of the FacesContext instance associated with the current request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5571 + + void + + jakarta.faces.lifecycle.LifecycleWrapper.execute +
+ ( + FacesContext + ) + +
+ throws + FacesException +
+
+
+ if thrown during the execution of the request processing lifecycle + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5572 + + PhaseListener[] + + jakarta.faces.lifecycle.LifecycleWrapper.getPhaseListeners +
+
+
+ Return the set of registered PhaseListeners for this Lifecycle instance. If there are + no registered listeners, a zero-length array is returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5573 + + Lifecycle + + jakarta.faces.lifecycle.LifecycleWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5574 + + LifecycleWrapper + + jakarta.faces.lifecycle.LifecycleWrapper.LifecycleWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:5575 + + LifecycleWrapper + + jakarta.faces.lifecycle.LifecycleWrapper.LifecycleWrapper +
+ ( + Lifecycle + ) +
+
+ If this lifecycle has been decorated, the implementation doing the decorating should + push the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5576 + + void + + jakarta.faces.lifecycle.LifecycleWrapper.removePhaseListener +
+ ( + PhaseListener + ) +
+
+ Deregister an existing PhaseListener instance that is no longer interested in being + notified before and after the processing for standard phases of the request processing lifecycle. If + no such listener instance has been registered, no action is taken. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5577 + + void + + jakarta.faces.lifecycle.LifecycleWrapper.render +
+ ( + FacesContext + ) +
+
+ Execute the Render Response phase of the request processing lifecycle, unless the + responseComplete() method has been called on the FacesContext instance associated with the current + request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5578 + + void + + jakarta.faces.lifecycle.LifecycleWrapper.render +
+ ( + FacesContext + ) + +
+ throws + FacesException +
+
+
+ if an exception is thrown during the execution of the request processing lifecycle + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5579 + + ArrayDataModel + + jakarta.faces.model.ArrayDataModel.ArrayDataModel +
+
+
+ Construct a new ArrayDataModel with no specified wrapped data. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5580 + + ArrayDataModel + + jakarta.faces.model.ArrayDataModel.ArrayDataModel +
+ ( + Object[] + ) +
+
+ Construct a new ArrayDataModel wrapping the specified array. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5581 + + int + + jakarta.faces.model.ArrayDataModel.getRowCount +
+
+
+ If there is wrappedData available, return the length of the array. If no wrappedData is + available, return -1. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5582 + + Object + + jakarta.faces.model.ArrayDataModel.getRowData +
+
+
+ If row data is available, return the array element at the index specified by rowIndex. + If no wrapped data is available, return null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5583 + + int + + jakarta.faces.model.ArrayDataModel.getRowIndex +
+
+
+ Return the zero-relative index of the currently selected row. If we are not currently + positioned on a row, or no wrappedData is available, return -1. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5584 + + Object + + jakarta.faces.model.ArrayDataModel.getWrappedData +
+
+
+ Return the object representing the data wrapped by this DataModel, if any. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5585 + + boolean + + jakarta.faces.model.ArrayDataModel.isRowAvailable +
+
+
+ Return true if there is wrappedData available, and the current value of rowIndex is + greater than or equal to zero, and less than the length of the array. Otherwise, return false. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5586 + + void + + jakarta.faces.model.ArrayDataModel.setRowIndex +
+ ( + int + ) +
+
+ Set the zero-relative index of the currently selected row, or -1 to indicate that we + are not positioned on a row. It is possible to set the row index at a value for which the underlying + data collection does not contain any row data. Therefore, callers may use the isRowAvailable() + method to detect whether row data will be available for use by the getRowData() method. If there is + no wrappedData available when this method is called, the specified rowIndex is stored (and may be + retrieved by a subsequent call to getRowData()), but no event is sent. Otherwise, if the currently + selected row index is changed by this call, a DataModelEvent will be sent to the rowSelected() + method of all registered DataModelListeners. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5587 + + void + + jakarta.faces.model.ArrayDataModel.setWrappedData +
+ ( + Object + ) +
+
+ Set the object representing the data collection wrapped by this DataModel. If the + specified data is null, detach this DataModel from any previously wrapped data collection instead. + If data is non-null, the currently selected row index must be set to zero, and a DataModelEvent must + be sent to the rowSelected() method of all registered DataModelListeners indicating that this row is + now selected. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5588 + + CollectionDataModel + + jakarta.faces.model.CollectionDataModel.CollectionDataModel +
+
+
+ Construct a new CollectionDataModel with no specified wrapped data. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5589 + + CollectionDataModel + + jakarta.faces.model.CollectionDataModel.CollectionDataModel +
+ ( + Collection + ) +
+
+ Construct a new CollectionDataModel wrapping the specified list. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5590 + + int + + jakarta.faces.model.CollectionDataModel.getRowCount +
+
+
+ If there is wrappedData available, return the length of the list. If no wrappedData is + available, return -1. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5591 + + Object + + jakarta.faces.model.CollectionDataModel.getRowData +
+
+
+ If row data is available, return the array element at the index specified by rowIndex. + If no wrapped data is available, return null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5592 + + int + + jakarta.faces.model.CollectionDataModel.getRowIndex +
+
+
+ Return the zero-relative index of the currently selected row. If we are not currently + positioned on a row, or no wrappedData is available, return -1. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5593 + + Object + + jakarta.faces.model.CollectionDataModel.getWrappedData +
+
+
+ Return the object representing the data wrapped by this DataModel, if any. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5594 + + boolean + + jakarta.faces.model.CollectionDataModel.isRowAvailable +
+
+
+ Return true if there is wrappedData available, and the current value of rowIndex is + greater than or equal to zero, and less than the size of the list. Otherwise, return false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5595 + + void + + jakarta.faces.model.CollectionDataModel.setRowIndex +
+ ( + int + ) +
+
+ Set the zero-relative index of the currently selected row, or -1 to indicate that we + are not positioned on a row. It is possible to set the row index at a value for which the underlying + data collection does not contain any row data. Therefore, callers may use the isRowAvailable() + method to detect whether row data will be available for use by the getRowData() method. If there is + no wrappedData available when this method is called, the specified rowIndex is stored (and may be + retrieved by a subsequent call to getRowData()), but no event is sent. Otherwise, if the currently + selected row index is changed by this call, a DataModelEvent will be sent to the rowSelected() + method of all registered DataModelListeners. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5596 + + void + + jakarta.faces.model.CollectionDataModel.setWrappedData +
+ ( + Object + ) +
+
+ Set the wrapped data. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5597 + + void + + jakarta.faces.model.DataModel.addDataModelListener +
+ ( + DataModelListener + ) +
+
+ Add a new DataModelListener to the set interested in notifications from this DataModel. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5598 + + DataModel + + jakarta.faces.model.DataModel.DataModel +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5599 + + DataModelListener[] + + jakarta.faces.model.DataModel.getDataModelListeners +
+
+
+ Return the set of DataModelListeners interested in notifications from this DataModel. + If there are no such listeners, an empty array is returned. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5600 + + int + + jakarta.faces.model.DataModel.getRowCount +
+
+
+ Return the number of rows of data objects represented by this DataModel. If the number + of rows is unknown, or no wrappedData is available, return -1. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5601 + + Object + + jakarta.faces.model.DataModel.getRowData +
+
+
+ Return an object representing the data for the currently selected row index. If no + wrappedData is available, return null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5602 + + int + + jakarta.faces.model.DataModel.getRowIndex +
+
+
+ Return the zero-relative index of the currently selected row. If we are not currently + positioned on a row, or no wrappedData is available, return -1. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5603 + + Object + + jakarta.faces.model.DataModel.getWrappedData +
+
+
+ Return the object representing the data wrapped by this DataModel, if any. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5604 + + boolean + + jakarta.faces.model.DataModel.isRowAvailable +
+
+
+ Return a flag indicating whether there is rowData available at the current rowIndex. If + no wrappedData is available, return false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5605 + + Iterator + + jakarta.faces.model.DataModel.iterator +
+
+
+ Return a read-only Iterator over the row data for this model. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5606 + + void + + jakarta.faces.model.DataModel.removeDataModelListener +
+ ( + DataModelListener + ) +
+
+ Remove an existing DataModelListener from the set interested in notifications from this + DataModel. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5607 + + void + + jakarta.faces.model.DataModel.setRowIndex +
+ ( + int + ) +
+
+ Set the zero-relative index of the currently selected row, or -1 to indicate that we + are not positioned on a row. It is possible to set the row index at a value for which the underlying + data collection does not contain any row data. Therefore, callers may use the isRowAvailable() + method to detect whether row data will be available for use by the getRowData() method. If there is + no wrappedData available when this method is called, the specified rowIndex is stored (and may be + retrieved by a subsequent call to getRowData()), but no event is sent. Otherwise, if the currently + selected row index is changed by this call, a DataModelEvent will be sent to the rowSelected() + method of all registered DataModelListeners. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5608 + + void + + jakarta.faces.model.DataModel.setWrappedData +
+ ( + Object + ) +
+
+ Set the object representing the data collection wrapped by this DataModel. If the + specified data is null, detach this DataModel from any previously wrapped data collection instead. + If data is non-null, the currently selected row index must be set to zero, and a DataModelEvent must + be sent to the rowSelected() method of all registered DataModelListeners indicating that this row is + now selected. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5609 + + DataModelEvent + + jakarta.faces.model.DataModelEvent.DataModelEvent +
+ ( + DataModel + , +
+ int + , +
+ Object + ) +
+
+ Construct an event object that is associated with the specified row index and + associated data. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5610 + + DataModel + + jakarta.faces.model.DataModelEvent.getDataModel +
+
+
+ Return the DataModel that fired this event. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5611 + + Object + + jakarta.faces.model.DataModelEvent.getRowData +
+
+
+ Return the object representing the data for the specified row index, or null for no + associated row data. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5612 + + int + + jakarta.faces.model.DataModelEvent.getRowIndex +
+
+
+ Return the row index for this event, or -1 for no specific row. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5613 + + void + + jakarta.faces.model.DataModelListener.rowSelected +
+ ( + DataModelEvent + ) +
+
+ Notification that a particular row index, with the associated row data, has been + selected for processing. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5614 + + Class + + jakarta.faces.model.FacesDataModel.forClass +
+
+
+ The value of this annotation attribute is taken to be the type that the DataModel that + is annotated with this annotation is able to wrap. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5615 + + Class + + jakarta.faces.model.FacesDataModel.Literal.forClass +
+
+
+ The value of this annotation attribute is taken to be the type that the DataModel that + is annotated with this annotation is able to wrap. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5616 + + Literal + + jakarta.faces.model.FacesDataModel.Literal.of +
+ ( + Class + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5617 + + int + + jakarta.faces.model.IterableDataModel.getRowCount +
+
+
+ Return the number of rows of data objects represented by this DataModel. If the number + of rows is unknown, or no wrappedData is available, return -1. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5618 + + Object + + jakarta.faces.model.IterableDataModel.getRowData +
+
+
+ Return an object representing the data for the currenty selected row index. If no + wrappedData is available, return null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5619 + + int + + jakarta.faces.model.IterableDataModel.getRowIndex +
+
+
+ Return the zero-relative index of the currently selected row. If we are not currently + positioned on a row, or no wrappedData is available, return -1. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5620 + + Object + + jakarta.faces.model.IterableDataModel.getWrappedData +
+
+
+ Return the object representing the data wrapped by this DataModel, if any. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5621 + + boolean + + jakarta.faces.model.IterableDataModel.isRowAvailable +
+
+
+ Return a flag indicating whether there is rowData available at the current rowIndex. If + no wrappedData is available, return false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5622 + + IterableDataModel + + jakarta.faces.model.IterableDataModel.IterableDataModel +
+
+
+ Construct a new IterableDataModel with no specified wrapped data. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5623 + + IterableDataModel + + jakarta.faces.model.IterableDataModel.IterableDataModel +
+ ( + Iterable + ) +
+
+ Construct a new IterableDataModel wrapping the specified iterable. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5624 + + void + + jakarta.faces.model.IterableDataModel.setRowIndex +
+ ( + int + ) +
+
+ Set the zero-relative index of the currently selected row, or -1 to indicate that we + are not positioned on a row. It is possible to set the row index at a value for which the underlying + data collection does not contain any row data. Therefore, callers may use the isRowAvailable() + method to detect whether row data will be available for use by the getRowData() method. If there is + no wrappedData available when this method is called, the specified rowIndex is stored (and may be + retrieved by a subsequent call to getRowData()), but no event is sent. Otherwise, if the currently + selected row index is changed by this call, a DataModelEvent will be sent to the rowSelected() + method of all registered DataModelListeners. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5625 + + void + + jakarta.faces.model.IterableDataModel.setWrappedData +
+ ( + Object + ) +
+
+ Set the object representing the data collection wrapped by this DataModel. If the + specified data is null, detach this DataModel from any previously wrapped data collection instead. + If data is non-null, the currently selected row index must be set to zero, and a DataModelEvent must + be sent to the rowSelected() method of all registered DataModelListeners indicating that this row is + now selected. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5626 + + int + + jakarta.faces.model.ListDataModel.getRowCount +
+
+
+ If there is wrappedData available, return the length of the list. If no wrappedData is + available, return -1. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5627 + + Object + + jakarta.faces.model.ListDataModel.getRowData +
+
+
+ If row data is available, return the array element at the index specified by rowIndex. + If no wrapped data is available, return null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5628 + + int + + jakarta.faces.model.ListDataModel.getRowIndex +
+
+
+ Return the zero-relative index of the currently selected row. If we are not currently + positioned on a row, or no wrappedData is available, return -1. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5629 + + Object + + jakarta.faces.model.ListDataModel.getWrappedData +
+
+
+ Return the object representing the data wrapped by this DataModel, if any. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5630 + + boolean + + jakarta.faces.model.ListDataModel.isRowAvailable +
+
+
+ Return true if there is wrappedData available, and the current value of rowIndex is + greater than or equal to zero, and less than the size of the list. Otherwise, return false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5631 + + ListDataModel + + jakarta.faces.model.ListDataModel.ListDataModel +
+
+
+ Construct a new ListDataModel with no specified wrapped data. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5632 + + ListDataModel + + jakarta.faces.model.ListDataModel.ListDataModel +
+ ( + List + ) +
+
+ Construct a new ListDataModel wrapping the specified list. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5633 + + void + + jakarta.faces.model.ListDataModel.setRowIndex +
+ ( + int + ) +
+
+ Set the zero-relative index of the currently selected row, or -1 to indicate that we + are not positioned on a row. It is possible to set the row index at a value for which the underlying + data collection does not contain any row data. Therefore, callers may use the isRowAvailable() + method to detect whether row data will be available for use by the getRowData() method. If there is + no wrappedData available when this method is called, the specified rowIndex is stored (and may be + retrieved by a subsequent call to getRowData()), but no event is sent. Otherwise, if the currently + selected row index is changed by this call, a DataModelEvent will be sent to the rowSelected() + method of all registered DataModelListeners. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5634 + + void + + jakarta.faces.model.ListDataModel.setWrappedData +
+ ( + Object + ) +
+
+ Set the object representing the data collection wrapped by this DataModel. If the + specified data is null, detach this DataModel from any previously wrapped data collection instead. + If data is non-null, the currently selected row index must be set to zero, and a DataModelEvent must + be sent to the rowSelected() method of all registered DataModelListeners indicating that this row is + now selected. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5635 + + int + + jakarta.faces.model.ResultSetDataModel.getRowCount +
+
+
+ Return -1, since ResultSet does not provide a standard way to determine the number of + available rows without scrolling through the entire ResultSet, and this can be very expensive if the + number of rows is large. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5636 + + Map + + jakarta.faces.model.ResultSetDataModel.getRowData +
+
+
+ If row data is available, return a Map representing the values of the columns for the + row specified by rowIndex, keyed by the corresponding column names. If no wrapped data is available, + return null. If a non-null Map is returned, its behavior must correspond to the contract for a + mutable Map as described in the JavaDocs for AbstractMap, with the following exceptions and + specialized behavior: The Map, and any supporting objects it returns, must perform all column name + comparisons in a case-insensitive manner. This case-insensitivity must be implemented using a + case-insensitive Comparator, such as String.CASE_INSENSITIVE_ORDER. The following methods must throw + UnsupportedOperationException: clear(), remove(). The entrySet() method must return a Set that has + the following behavior: Throw UnsupportedOperationException for any attempt to add or remove entries + from the Set, either directly or indirectly through an Iterator returned by the Set. Updates to the + value of an entry in this set must write through to the corresponding column value in the underlying + ResultSet. The keySet() method must return a Set that throws UnsupportedOperationException on any + attempt to add or remove keys, either directly or through an Iterator returned by the Set. The put() + method must throw IllegalArgumentException if a key value for which containsKey() returns false is + specified. However, if a key already present in the Map is specified, the specified value must write + through to the corresponding column value in the underlying ResultSet. The values() method must + return a Collection that throws UnsupportedOperationException on any attempt to add or remove + values, either directly or through an Iterator returned by the Collection. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5637 + + int + + jakarta.faces.model.ResultSetDataModel.getRowIndex +
+
+
+ Return the zero-relative index of the currently selected row. If we are not currently + positioned on a row, or no wrappedData is available, return -1. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5638 + + Object + + jakarta.faces.model.ResultSetDataModel.getWrappedData +
+
+
+ Return the object representing the data wrapped by this DataModel, if any. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5639 + + boolean + + jakarta.faces.model.ResultSetDataModel.isRowAvailable +
+
+
+ Return true if there is wrappedData available, and the result of calling absolute() on + the underlying ResultSet, passing the current value of rowIndex plus one (to account for the fact + that ResultSet uses one-relative indexing), returns true. Otherwise, return false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5640 + + ResultSetDataModel + + jakarta.faces.model.ResultSetDataModel.ResultSetDataModel +
+
+
+ Construct a new ResultSetDataModel with no specified wrapped data. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5641 + + ResultSetDataModel + + jakarta.faces.model.ResultSetDataModel.ResultSetDataModel +
+ ( + ResultSet + ) +
+
+ Construct a new ResultSetDataModel wrapping the specified ResultSet. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5642 + + void + + jakarta.faces.model.ResultSetDataModel.setRowIndex +
+ ( + int + ) +
+
+ Set the zero-relative index of the currently selected row, or -1 to indicate that we + are not positioned on a row. It is possible to set the row index at a value for which the underlying + data collection does not contain any row data. Therefore, callers may use the isRowAvailable() + method to detect whether row data will be available for use by the getRowData() method. If there is + no wrappedData available when this method is called, the specified rowIndex is stored (and may be + retrieved by a subsequent call to getRowData()), but no event is sent. Otherwise, if the currently + selected row index is changed by this call, a DataModelEvent will be sent to the rowSelected() + method of all registered DataModelListeners. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5643 + + void + + jakarta.faces.model.ResultSetDataModel.setWrappedData +
+ ( + Object + ) +
+
+ Set the object representing the data collection wrapped by this DataModel. If the + specified data is null, detach this DataModel from any previously wrapped data collection instead. + If data is non-null, the currently selected row index must be set to zero, and a DataModelEvent must + be sent to the rowSelected() method of all registered DataModelListeners indicating that this row is + now selected. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5644 + + int + + jakarta.faces.model.ScalarDataModel.getRowCount +
+
+
+ If there is wrappedData available, return 1. If no wrappedData is available, return -1. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5645 + + Object + + jakarta.faces.model.ScalarDataModel.getRowData +
+
+
+ If wrapped data is available, return the wrapped data instance. Otherwise, return null. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5646 + + int + + jakarta.faces.model.ScalarDataModel.getRowIndex +
+
+
+ Return the zero-relative index of the currently selected row. If we are not currently + positioned on a row, or no wrappedData is available, return -1. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5647 + + Object + + jakarta.faces.model.ScalarDataModel.getWrappedData +
+
+
+ Return the object representing the data wrapped by this DataModel, if any. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5648 + + boolean + + jakarta.faces.model.ScalarDataModel.isRowAvailable +
+
+
+ Return true if there is wrappedData available, and the current value of rowIndex is + zero. Otherwise, return false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5649 + + ScalarDataModel + + jakarta.faces.model.ScalarDataModel.ScalarDataModel +
+
+
+ Construct a new ScalarDataModel with no specified wrapped data. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5650 + + ScalarDataModel + + jakarta.faces.model.ScalarDataModel.ScalarDataModel +
+ ( + Object + ) +
+
+ Construct a new ScalarDataModel wrapping the specified scalar object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5651 + + void + + jakarta.faces.model.ScalarDataModel.setRowIndex +
+ ( + int + ) +
+
+ Set the zero-relative index of the currently selected row, or -1 to indicate that we + are not positioned on a row. It is possible to set the row index at a value for which the underlying + data collection does not contain any row data. Therefore, callers may use the isRowAvailable() + method to detect whether row data will be available for use by the getRowData() method. If there is + no wrappedData available when this method is called, the specified rowIndex is stored (and may be + retrieved by a subsequent call to getRowData()), but no event is sent. Otherwise, if the currently + selected row index is changed by this call, a DataModelEvent will be sent to the rowSelected() + method of all registered DataModelListeners. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5652 + + void + + jakarta.faces.model.ScalarDataModel.setWrappedData +
+ ( + Object + ) +
+
+ Set the object representing the data collection wrapped by this DataModel. If the + specified data is null, detach this DataModel from any previously wrapped data collection instead. + If data is non-null, the currently selected row index must be set to zero, and a DataModelEvent must + be sent to the rowSelected() method of all registered DataModelListeners indicating that this row is + now selected. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5653 + + String + + jakarta.faces.model.SelectItem.getDescription +
+
+
+ Return a description of this item, for use in development tools. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5654 + + String + + jakarta.faces.model.SelectItem.getLabel +
+
+
+ Return the label of this item, to be rendered visibly for the user. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5655 + + Object + + jakarta.faces.model.SelectItem.getValue +
+
+
+ Return the value of this item, to be delivered to the model if this item is selected by + the user. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5656 + + boolean + + jakarta.faces.model.SelectItem.isDisabled +
+
+
+ Return the disabled flag for this item, which should modify the rendered output to make + this item unavailable for selection by the user if set to true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5657 + + boolean + + jakarta.faces.model.SelectItem.isEscape +
+
+
+ If and only if this returns true, the code that renders this select item must escape + the label using escaping syntax appropriate to the content type being rendered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5658 + + boolean + + jakarta.faces.model.SelectItem.isNoSelectionOption +
+
+
+ Return the value of the noSelectionOption property. If the value of this property is + true, the system interprets the option represented by this SelectItem instance as representing a "no + selection" option. See UISelectOne#validateValue and UISelectMany#validateValue for usage. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5659 + + SelectItem + + jakarta.faces.model.SelectItem.SelectItem +
+
+
+ Construct a SelectItem with no initialized property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5660 + + SelectItem + + jakarta.faces.model.SelectItem.SelectItem +
+ ( + Object + ) +
+
+ Construct a SelectItem with the specified value. The label property will be set to the + value (converted to a String, if necessary), the description property will be set to null, the + disabled property will be set to false, and the escape property will be set to ( true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5661 + + SelectItem + + jakarta.faces.model.SelectItem.SelectItem +
+ ( + Object + , +
+ String + ) +
+
+ Construct a SelectItem with the specified value and label. The description property + will be set to null, the disabled property will be set to false, and the escape property will be set + to true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5662 + + SelectItem + + jakarta.faces.model.SelectItem.SelectItem +
+ ( + Object + , +
+ String + , +
+ String + ) +
+
+ Construct a SelectItem instance with the specified value, label and description. This + disabled property will be set to false, and the escape property will be set to true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5663 + + SelectItem + + jakarta.faces.model.SelectItem.SelectItem +
+ ( + Object + , +
+ String + , +
+ String + , +
+ boolean + ) +
+
+ Construct a SelectItem instance with the specified property values. The escape property + will be set to true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5664 + + SelectItem + + jakarta.faces.model.SelectItem.SelectItem +
+ ( + Object + , +
+ String + , +
+ String + , +
+ boolean + , +
+ boolean + ) +
+
+ Construct a SelectItem instance with the specified property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5665 + + SelectItem + + jakarta.faces.model.SelectItem.SelectItem +
+ ( + Object + , +
+ String + , +
+ String + , +
+ boolean + , +
+ boolean + , +
+ boolean + ) +
+
+ Construct a SelectItem instance with the specified property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5666 + + void + + jakarta.faces.model.SelectItem.setDescription +
+ ( + String + ) +
+
+ Set the description of this item, for use in development tools. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5667 + + void + + jakarta.faces.model.SelectItem.setDisabled +
+ ( + boolean + ) +
+
+ Set the disabled flag for this item, which should modify the rendered output to make + this item unavailable for selection by the user if set to true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5668 + + void + + jakarta.faces.model.SelectItem.setEscape +
+ ( + boolean + ) +
+
+ Set the value of the escape property. See #isEscape. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5669 + + void + + jakarta.faces.model.SelectItem.setLabel +
+ ( + String + ) +
+
+ Set the label of this item, to be rendered visibly for the user. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5670 + + void + + jakarta.faces.model.SelectItem.setNoSelectionOption +
+ ( + boolean + ) +
+
+ Set the value of the noSelectionOption property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5671 + + void + + jakarta.faces.model.SelectItem.setValue +
+ ( + Object + ) +
+
+ Set the value of this item, to be delivered to the model if this item is selected by + this user. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5672 + + SelectItem[] + + jakarta.faces.model.SelectItemGroup.getSelectItems +
+
+
+ Return the set of subordinate SelectItems for this group. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5673 + + SelectItemGroup + + jakarta.faces.model.SelectItemGroup.SelectItemGroup +
+
+
+ Construct a SelectItemGroup with no initialized property values. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5674 + + SelectItemGroup + + jakarta.faces.model.SelectItemGroup.SelectItemGroup +
+ ( + String + ) +
+
+ Construct a SelectItemGroup with the specified label and no associated selectItems. The + value property will be set to a zero-length String, the description property will be set to null, + and the disabled property will be set to false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5675 + + SelectItemGroup + + jakarta.faces.model.SelectItemGroup.SelectItemGroup +
+ ( + String + , +
+ String + , +
+ boolean + , +
+ SelectItem[] + ) +
+
+ Construct a SelectItemGroup with the specified properties. The value property will be + set to a zero-length String. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5676 + + SelectItemGroup + + jakarta.faces.model.SelectItemGroup.SelectItemGroup +
+ ( + String + , +
+ String + , +
+ boolean + , +
+ Collection + ) +
+
+ Construct a SelectItemGroup with the specified properties. The value property will be + set to a zero-length String. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5677 + + void + + jakarta.faces.model.SelectItemGroup.setSelectItems +
+ ( + SelectItem[] + ) +
+
+ Set the set of subordinate SelectItems for this group as a variable array. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5678 + + void + + jakarta.faces.model.SelectItemGroup.setSelectItems +
+ ( + Collection + ) +
+
+ Set the set of subordinate SelectItems for this group as a collection. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5679 + + String + + jakarta.faces.push.Push.channel +
+
+
+ (Optional) The name of the push channel. If not specified the name of the injection + target field will be used. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5680 + + String + + jakarta.faces.push.Push.Literal.channel +
+
+
+ (Optional) The name of the push channel. If not specified the name of the injection + target field will be used. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5681 + + Literal + + jakarta.faces.push.Push.Literal.of +
+ ( + String + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5682 + + Set + + jakarta.faces.push.PushContext.send +
+ ( + Object + ) +
+
+ Send given message object to the push socket channel as identified by #64;Push. The + message object will be encoded as JSON and be available as first argument of the JavaScript listener + function declared in . + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5683 + + Set + + jakarta.faces.push.PushContext.send +
+ ( + Object + , +
+ Serializable + ) +
+
+ Send given message object to the push socket channel as identified by #64;Push, + targeted to the given user as identified by . The message object will be encoded as JSON and be + available as first argument of the JavaScript listener function declared in . + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5684 + + Map + + jakarta.faces.push.PushContext.send +
+ ( + Object + , +
+ Collection + ) +
+
+ Send given message object to the push socket channel as identified by #64;Push, + targeted to the given users as identified by . The message object will be encoded as JSON and be + available as first argument of the JavaScript listener function declared in . + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5685 + + ClientBehaviorRenderer + + jakarta.faces.render.ClientBehaviorRenderer.ClientBehaviorRenderer +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5686 + + void + + jakarta.faces.render.ClientBehaviorRenderer.decode +
+ ( + FacesContext + , +
+ UIComponent + , +
+ ClientBehavior + ) +
+
+ Decode any new state of this ClientBehavior from the request contained in the specified + FacesContext. During decoding, events may be enqueued for later processing (by event listeners who + have registered an interest), by calling queueEvent(). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5687 + + String + + jakarta.faces.render.ClientBehaviorRenderer.getScript +
+ ( + ClientBehaviorContext + , +
+ ClientBehavior + ) +
+
+ Return the script that implements this ClientBehavior's client-side logic. The default + implementation returns null. ClientBehaviorRenderer.getScript() implementations are allowed to + return null to indicate that no script is required for this particular getScript() call. For + example, a ClientBehaviorRenderer implementation may return null if the associated ClientBehavior is + disabled. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5688 + + String + + jakarta.faces.render.FacesBehaviorRenderer.rendererType +
+
+
+ Within the RenderKit, the value of this annotation attribute is taken to be the + renderer-type + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5689 + + String + + jakarta.faces.render.FacesBehaviorRenderer.renderKitId +
+
+
+ The value of this annotation attribute is taken to be the render-kit-id in which an + instance of this class of Renderer must be installed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5690 + + String + + jakarta.faces.render.FacesRenderer.componentFamily +
+
+
+ The value of this annotation attribute is taken to be the component-family which, in + combination with #rendererType can be used to obtain a reference to an instance of this Renderer by + calling jakarta.faces.render.RenderKit#getRenderer(java.lang.String, java.lang.String). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5691 + + String + + jakarta.faces.render.FacesRenderer.rendererType +
+
+
+ The value of this annotation attribute is taken to be the renderer-type which, in + combination with #componentFamily can be used to obtain a reference to an instance of this Renderer + by calling jakarta.faces.render.RenderKit#getRenderer(java.lang.String, java.lang.String). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5692 + + String + + jakarta.faces.render.FacesRenderer.renderKitId +
+
+
+ The value of this annotation attribute is taken to be the render-kit-id in which an + instance of this class of Renderer must be installed. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5693 + + String + + jakarta.faces.render.Renderer.convertClientId +
+ ( + FacesContext + , +
+ String + ) +
+
+ Convert the component generated client id to a form suitable for transmission to the + client. The default implementation returns the argument clientId unchanged. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5694 + + Object + + jakarta.faces.render.Renderer.getConvertedValue +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ Attempt to convert previously stored state information into an object of the type + required for this component (optionally using the registered jakarta.faces.convert.Converter for + this component, if there is one). If conversion is successful, the new value should be returned from + this method; if not, a ConverterException should be thrown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5695 + + Object + + jakarta.faces.render.Renderer.getConvertedValue +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) + +
+ throws + ConverterException +
+
+
+ if the submitted value cannot be converted successfully. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5696 + + boolean + + jakarta.faces.render.Renderer.getRendersChildren +
+
+
+ Return a flag indicating whether this Renderer is responsible for rendering the + children the component it is asked to render. The default implementation returns false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5697 + + String + + jakarta.faces.render.RendererWrapper.convertClientId +
+ ( + FacesContext + , +
+ String + ) +
+
+ Convert the component generated client id to a form suitable for transmission to the + client. The default implementation returns the argument clientId unchanged. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5698 + + void + + jakarta.faces.render.RendererWrapper.decode +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Decode any new state of the specified UIComponent from the request contained in the + specified FacesContext, and store that state on the UIComponent. During decoding, events may be + enqueued for later processing (by event listeners that have registered an interest), by calling + queueEvent() on the associated UIComponent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5699 + + void + + jakarta.faces.render.RendererWrapper.encodeBegin +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Render the beginning specified UIComponent to the output stream or writer associated + with the response we are creating. If the conversion attempted in a previous call to + getConvertedValue() for this component failed, the state information saved during execution of + decode() should be used to reproduce the incorrect input. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5700 + + void + + jakarta.faces.render.RendererWrapper.encodeBegin +
+ ( + FacesContext + , +
+ UIComponent + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs while rendering + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5701 + + void + + jakarta.faces.render.RendererWrapper.encodeChildren +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Render the child components of this UIComponent, following the rules described for + encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if + the rendersChildren property of this component is true. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5702 + + void + + jakarta.faces.render.RendererWrapper.encodeChildren +
+ ( + FacesContext + , +
+ UIComponent + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs while rendering + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5703 + + void + + jakarta.faces.render.RendererWrapper.encodeEnd +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Render the ending of the current state of the specified UIComponent, following the + rules described for encodeBegin() to acquire the appropriate value to be rendered. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5704 + + void + + jakarta.faces.render.RendererWrapper.encodeEnd +
+ ( + FacesContext + , +
+ UIComponent + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs while rendering + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5705 + + Object + + jakarta.faces.render.RendererWrapper.getConvertedValue +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ Attempt to convert previously stored state information into an object of the type + required for this component (optionally using the registered jakarta.faces.convert.Converter for + this component, if there is one). If conversion is successful, the new value should be returned from + this method; if not, a ConverterException should be thrown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5706 + + Object + + jakarta.faces.render.RendererWrapper.getConvertedValue +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) + +
+ throws + ConverterException +
+
+
+ if the submitted value cannot be converted successfully. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5707 + + boolean + + jakarta.faces.render.RendererWrapper.getRendersChildren +
+
+
+ Return a flag indicating whether this Renderer is responsible for rendering the + children the component it is asked to render. The default implementation returns false. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5708 + + Renderer + + jakarta.faces.render.RendererWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5709 + + RendererWrapper + + jakarta.faces.render.RendererWrapper.RendererWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:5710 + + RendererWrapper + + jakarta.faces.render.RendererWrapper.RendererWrapper +
+ ( + Renderer + ) +
+
+ If this renderer has been decorated, the implementation doing the decorating should + push the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5711 + + void + + jakarta.faces.render.RenderKit.addClientBehaviorRenderer +
+ ( + String + , +
+ ClientBehaviorRenderer + ) +
+
+ Register the specified ClientBehaviorRenderer instance, associated with the specified + component type, to the set of ClientBehaviorRenderers registered with this RenderKit, replacing any + previously registered ClientBehaviorRenderer for this type. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5712 + + void + + jakarta.faces.render.RenderKit.addRenderer +
+ ( + String + , +
+ String + , +
+ Renderer + ) +
+
+ Register the specified Renderer instance, associated with the specified component + family and rendererType, to the set of Renderers registered with this RenderKit, replacing any + previously registered Renderer for this combination of identifiers. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5713 + + ResponseStream + + jakarta.faces.render.RenderKit.createResponseStream +
+ ( + OutputStream + ) +
+
+ Use the provided OutputStream to create a new ResponseStream instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5714 + + ResponseWriter + + jakarta.faces.render.RenderKit.createResponseWriter +
+ ( + Writer + , +
+ String + , +
+ String + ) +
+
+ Use the provided Writer to create a new ResponseWriter instance for the specified + (optional) content type, and character encoding. Implementors are advised to consult the + getCharacterEncoding() method of class jakarta.servlet.ServletResponse to get the required value for + the characterEncoding for this method. Since the Writer for this response will already have been + obtained (due to it ultimately being passed to this method), we know that the character encoding + cannot change during the rendering of the response. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5715 + + ClientBehaviorRenderer + + jakarta.faces.render.RenderKit.getClientBehaviorRenderer +
+ ( + String + ) +
+
+ Return the ClientBehaviorRenderer instance most recently registered for the specified + type, if any; otherwise, return null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5716 + + Iterator + + jakarta.faces.render.RenderKit.getClientBehaviorRendererTypes +
+
+
+ Return an Iterator over the ClientBehaviorRenderer types. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5717 + + Iterator + + jakarta.faces.render.RenderKit.getComponentFamilies +
+
+
+ Return an Iterator over the component-family entries supported by this RenderKit + instance. The default implementation of this method returns an empty Iterator + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5718 + + Renderer + + jakarta.faces.render.RenderKit.getRenderer +
+ ( + String + , +
+ String + ) +
+
+ Return the Renderer instance most recently registered for the specified component + family and rendererType, if any; otherwise, return null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5719 + + ResponseStateManager + + jakarta.faces.render.RenderKit.getResponseStateManager +
+
+
+ Return an instance of ResponseStateManager to handle rendering technology specific + state management decisions. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5720 + + RenderKit + + jakarta.faces.render.RenderKitFactory.getRenderKit +
+ ( + FacesContext + , +
+ String + ) +
+
+ Return a RenderKit instance for the specified render kit identifier, possibly + customized based on dynamic characteristics of the specified FacesContext, if non-null. If there is + no registered RenderKit for the specified identifier, return null. The set of available render kit + identifiers is available via the getRenderKitIds() method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5721 + + RenderKitFactory + + jakarta.faces.render.RenderKitFactory.getWrapped +
+
+
+ If this factory has been decorated, the implementation doing the decorating may + override this method to provide access to the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5722 + + RenderKitFactory + + jakarta.faces.render.RenderKitFactory.RenderKitFactory +
+ ( + RenderKitFactory + ) +
+
+ If this factory has been decorated, the implementation doing the decorating should push + the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5723 + + void + + jakarta.faces.render.RenderKitWrapper.addClientBehaviorRenderer +
+ ( + String + , +
+ ClientBehaviorRenderer + ) +
+
+ The default behavior of this method is to call + RenderKit#addClientBehaviorRenderer(String, ClientBehaviorRenderer) on the wrapped RenderKit object. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5724 + + void + + jakarta.faces.render.RenderKitWrapper.addRenderer +
+ ( + String + , +
+ String + , +
+ Renderer + ) +
+
+ The default behavior of this method is to call RenderKit#addRenderer(String, String, + Renderer) on the wrapped RenderKit object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5725 + + ResponseStream + + jakarta.faces.render.RenderKitWrapper.createResponseStream +
+ ( + OutputStream + ) +
+
+ The default behavior of this method is to call + RenderKit#createResponseStream(java.io.OutputStream) on the wrapped RenderKit object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5726 + + ResponseWriter + + jakarta.faces.render.RenderKitWrapper.createResponseWriter +
+ ( + Writer + , +
+ String + , +
+ String + ) +
+
+ The default behavior of this method is to call + RenderKit#createResponseWriter(java.io.Writer, String, String) on the wrapped RenderKit object. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5727 + + ClientBehaviorRenderer + + jakarta.faces.render.RenderKitWrapper.getClientBehaviorRenderer +
+ ( + String + ) +
+
+ The default behavior of this method is to call + RenderKit#getClientBehaviorRenderer(String) on the wrapped RenderKit object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5728 + + Iterator + + jakarta.faces.render.RenderKitWrapper.getClientBehaviorRendererTypes +
+
+
+ The default behavior of this method is to call + jakarta.faces.render.RenderKit#getClientBehaviorRendererTypes() on the wrapped RenderKit object. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5729 + + Iterator + + jakarta.faces.render.RenderKitWrapper.getComponentFamilies +
+
+
+ The default behavior of this method is to call + jakarta.faces.render.RenderKit#getComponentFamilies() on the wrapped RenderKit object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5730 + + Renderer + + jakarta.faces.render.RenderKitWrapper.getRenderer +
+ ( + String + , +
+ String + ) +
+
+ The default behavior of this method is to call RenderKit#getRenderer(String, String) on + the wrapped RenderKit object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5731 + + Iterator + + jakarta.faces.render.RenderKitWrapper.getRendererTypes +
+ ( + String + ) +
+
+ The default behavior of this method is to call RenderKit#getRendererTypes(String) on + the wrapped RenderKit object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5732 + + ResponseStateManager + + jakarta.faces.render.RenderKitWrapper.getResponseStateManager +
+
+
+ The default behavior of this method is to call + jakarta.faces.render.RenderKit#getResponseStateManager() on the wrapped RenderKit object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5733 + + RenderKit + + jakarta.faces.render.RenderKitWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5734 + + RenderKitWrapper + + jakarta.faces.render.RenderKitWrapper.RenderKitWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:5735 + + RenderKitWrapper + + jakarta.faces.render.RenderKitWrapper.RenderKitWrapper +
+ ( + RenderKit + ) +
+
+ If this render kit has been decorated, the implementation doing the decorating should + push the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5736 + + String + + jakarta.faces.render.ResponseStateManager.getCryptographicallyStrongTokenFromSession +
+ ( + FacesContext + ) +
+
+ Compliant implementations must return a cryptographically strong token for use to + protect views in this application. For backwards compatibility with earlier revisions, a default + implementation is provided that simply returns null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5737 + + Object + + jakarta.faces.render.ResponseStateManager.getState +
+ ( + FacesContext + , +
+ String + ) +
+
+ The implementation must inspect the current request and return an Object representing + the tree structure and component state passed in to a previous invocation of + #writeState(jakarta.faces.context.FacesContext,java.lang.Object). If the state saving method for + this application is jakarta.faces.application.StateManager#STATE_SAVING_METHOD_CLIENT, writeState() + will have encrypted the state in a tamper evident manner. If the state fails to decrypt, or decrypts + but indicates evidence of tampering, a jakarta.faces.application.ProtectedViewException must be + thrown. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5738 + + String + + jakarta.faces.render.ResponseStateManager.getViewState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ Return the specified state as a String without any markup related to the rendering + technology supported by this ResponseStateManager. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5739 + + boolean + + jakarta.faces.render.ResponseStateManager.isPostback +
+ ( + FacesContext + ) +
+
+ Return true if the current request is a postback. This method is leveraged from the + Restore View Phase to determine if jakarta.faces.application.ViewHandler#restoreView or + jakarta.faces.application.ViewHandler#createView should be called. The default implementation must + return true if this ResponseStateManager instance wrote out state on a previous request to which + this request is a postback, false otherwise. The implementation of this method for the Standard HTML + RenderKit must consult the jakarta.faces.context.ExternalContext's requestParameterMap and return + true if and only if there is a key equal to the value of the symbolic constant #VIEW_STATE_PARAM. + For backwards compatibility with implementations of ResponseStateManager prior to Jakarta Faces 1.2, + a default implementation is provided that consults the jakarta.faces.context.ExternalContext's + requestParameterMap and return true if its size is greater than 0. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5740 + + boolean + + jakarta.faces.render.ResponseStateManager.isStateless +
+ ( + FacesContext + , +
+ String + ) +
+
+ If the preceding call to #writeState(jakarta.faces.context.FacesContext, + java.lang.Object) was stateless, return true. If the preceding call to writeState() was stateful, + return false. Otherwise throw IllegalStateException. To preserve backward compatibility with custom + implementations that may have extended from an earlier version of this class, an implementation is + provided that returns false. A compliant implementation must override this method to take the + specified action. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5741 + + ResponseStateManager + + jakarta.faces.render.ResponseStateManager.ResponseStateManager +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5742 + + void + + jakarta.faces.render.ResponseStateManager.writeState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ Take the argument state and write it into the output using the current ResponseWriter, + which must be correctly positioned already. Call FacesContext#getViewRoot(). If + jakarta.faces.component.UIComponent#isTransient() returns true, take implementation specific action + so that the following call to #isStateless returns true and return. Otherwise, proceed as follows. + If the state is to be written out to hidden fields, the implementation must take care to make all + necessary character replacements to make the Strings suitable for inclusion as an HTTP request + paramater. If the state saving method for this application is + jakarta.faces.application.StateManager#STATE_SAVING_METHOD_CLIENT, the implementation must encrypt + the state to be saved to the client in a tamper evident manner. If the state saving method for this + application is jakarta.faces.application.StateManager#STATE_SAVING_METHOD_SERVER, and the current + request is an Ajax request jakarta.faces.context.PartialViewContext#isAjaxRequest returns true), use + the current view state identifier if it is available (do not generate a new identifier). Write out + the render kit identifier associated with this ResponseStateManager implementation with the name as + the value of the String constant ResponseStateManager.RENDER_KIT_ID_PARAM. The render kit identifier + must not be written if: it is the default render kit identifier as returned by + jakarta.faces.application.Application#getDefaultRenderKitId() or the render kit identfier is the + value of jakarta.faces.render.RenderKitFactory.HTML_BASIC_RENDER_KIT and + jakarta.faces.application.Application#getDefaultRenderKitId() returns null. The + jakarta.faces.lifecycle.ClientWindow must be written using these steps. Call + jakarta.faces.context.ExternalContext#getClientWindow. If the result is null, take no further action + regarding the ClientWindow. If the result is non-null, write a hidden field whose name is + #CLIENT_WINDOW_PARAM and whose id is jakarta.faces.ClientWindow where is the currently configured + UINamingContainer.getSeparatorChar(). is the return from UIViewRoot.getContainerClientId() on the + view from whence this state originated. is a number that must be unique within this view, but must + not be included in the view state. The value of the field is implementation dependent but must + uniquely identify this window within the user's session. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5743 + + void + + jakarta.faces.render.ResponseStateManager.writeState +
+ ( + FacesContext + , +
+ Object + ) + +
+ throws + IOException +
+
+
+ if the state argument is not an array of length 2. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5744 + + BeanValidator + + jakarta.faces.validator.BeanValidator.BeanValidator +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5745 + + void + + jakarta.faces.validator.BeanValidator.clearInitialState +
+
+
+ Reset the PartialStateHolder to a non-delta tracking state. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5746 + + String + + jakarta.faces.validator.BeanValidator.getValidationGroups +
+
+
+ Return the validation groups passed to the Validation API when checking constraints. If + the validationGroupsArray attribute is omitted or empty, the validation groups will be inherited + from the branch defaults, or if there are no branch defaults, the jakarta.validation.groups.Default + group will be used. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5747 + + boolean + + jakarta.faces.validator.BeanValidator.initialStateMarked +
+
+
+ Return true if delta state changes are being tracked, otherwise false + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5748 + + boolean + + jakarta.faces.validator.BeanValidator.isTransient +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5749 + + void + + jakarta.faces.validator.BeanValidator.markInitialState +
+
+
+ The runtime must ensure that the #markInitialState method is called on each instance of + this interface in the view at the appropriate time to indicate the component is in its initial + state. The implementor of the interface must ensure that #initialStateMarked returns true from the + time markInitialState() is called until #clearInitialState is called, after which time + initialStateMarked() must return false. Also, during the time that the instance returns true from + initialStateMarked(), the implementation must return only the state that has changed in its + implementation of StateHolder#saveState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5750 + + void + + jakarta.faces.validator.BeanValidator.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5751 + + Object + + jakarta.faces.validator.BeanValidator.saveState +
+ ( + FacesContext + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5752 + + void + + jakarta.faces.validator.BeanValidator.setTransient +
+ ( + boolean + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5753 + + void + + jakarta.faces.validator.BeanValidator.setValidationGroups +
+ ( + String + ) +
+
+ A comma-separated list of validation groups which are used to filter which validations + get checked by this validator. If the validationGroupsArray attribute is omitted or is empty, the + validation groups will be inherited from the branch defaults or, if there are no branch defaults, + the jakarta.validation.groups.Default group will be used. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5754 + + void + + jakarta.faces.validator.BeanValidator.validate +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ Verify that the value is valid according to the Bean Validation constraints. Obtain a + ValidatorFactory instance by calling jakarta.validation.Validation#buildDefaultValidatorFactory. Let + validationGroupsArray be a Class [] representing validator groups set on the component by the tag + handler for this validator. The first search component terminates the search for the validation + groups value. If no such value is found use the class name of jakarta.validation.groups.Default as + the value of the validation groups. Let valueExpression be the return from calling + UIComponent#getValueExpression on the argument component, passing the literal string #8220;value + #8221; (without the quotes) as an argument. If this application is running in an environment with + Jakarta Expression Language, obtain the ValueReference from valueExpression and let valueBaseClase + be the return from calling ValueReference.getBase() and valueProperty be the return from calling + ValueReference.getProperty(). If an earlier version of Jakarta Expression Language is present, use + the appropriate methods to inspect valueExpression and derive values for valueBaseClass and + valueProperty. If no ValueReference can be obtained, take no action and return. If + ValueReference.getBase() return null, take no action and return. Obtain the ValidatorContext from + the ValidatorFactory. Decorate the MessageInterpolator returned from + ValidatorFactory#getMessageInterpolator with one that leverages the Locale returned from + jakarta.faces.component.UIViewRoot#getLocale, and store it in the ValidatorContext using + ValidatorContext#messageInterpolator. Obtain the jakarta.validation.Validator instance from the + validatorContext. Obtain a jakarta.validation.BeanDescriptor from the jakarta.validation.Validator. + If hasConstraints() on the BeanDescriptor returns false, take no action and return. Otherwise + proceed. Call jakarta.validation.Validator#validateValue, passing valueBaseClass, valueProperty, the + value argument, and validatorGroupsArray as arguments. If the returned Set lt;ConstraintViolation + gt; is non-empty, for each element in the Set, create a FacesMessage where the summary and detail + are the return from calling ConstraintViolation#getMessage. Capture all such FacesMessage instances + into a Collection and pass them to ValidatorException#ValidatorException(java.util.Collection). If + the #ENABLE_VALIDATE_WHOLE_BEAN_PARAM_NAME application parameter is enabled and this Validator + instance has validation groups other than or in addition to the Default group, record the fact that + this field failed validation so that any component later in the tree is able to skip class-level + validation for the bean for which this particular field is a property. Regardless of whether or not + #ENABLE_VALIDATE_WHOLE_BEAN_PARAM_NAME is set, throw the new exception. If the returned Set is + empty, the #ENABLE_VALIDATE_WHOLE_BEAN_PARAM_NAME application parameter is enabled and this + Validator instance has validation groups other than or in addition to the Default group, record the + fact that this field passed validation so that any component later in the tree is able to allow + class-level validation for the bean for which this particular field is a property. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5755 + + void + + jakarta.faces.validator.DoubleRangeValidator.clearInitialState +
+
+
+ Reset the PartialStateHolder to a non-delta tracking state. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5756 + + boolean + + jakarta.faces.validator.DoubleRangeValidator.equals +
+ ( + Object + ) +
+
+ Overrides the default equals method to take the minimum and maximum into account when + comparing DoubleRangeValidator instances. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5757 + + int + + jakarta.faces.validator.DoubleRangeValidator.hashCode +
+
+
+ Overrides the default hash code method to take the minimum and maximum into account + when generating the hash code. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5758 + + boolean + + jakarta.faces.validator.DoubleRangeValidator.initialStateMarked +
+
+
+ Return true if delta state changes are being tracked, otherwise false + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5759 + + boolean + + jakarta.faces.validator.DoubleRangeValidator.isTransient +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5760 + + void + + jakarta.faces.validator.DoubleRangeValidator.markInitialState +
+
+
+ The runtime must ensure that the #markInitialState method is called on each instance of + this interface in the view at the appropriate time to indicate the component is in its initial + state. The implementor of the interface must ensure that #initialStateMarked returns true from the + time markInitialState() is called until #clearInitialState is called, after which time + initialStateMarked() must return false. Also, during the time that the instance returns true from + initialStateMarked(), the implementation must return only the state that has changed in its + implementation of StateHolder#saveState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5761 + + void + + jakarta.faces.validator.DoubleRangeValidator.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5762 + + Object + + jakarta.faces.validator.DoubleRangeValidator.saveState +
+ ( + FacesContext + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5763 + + void + + jakarta.faces.validator.DoubleRangeValidator.setTransient +
+ ( + boolean + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5764 + + void + + jakarta.faces.validator.DoubleRangeValidator.validate +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5765 + + void + + jakarta.faces.validator.DoubleRangeValidator.validate +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) + +
+ throws + ValidatorException +
+
+
+ {@inheritDoc} + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5766 + + boolean + + jakarta.faces.validator.FacesValidator.isDefault +
+
+
+ If true, the validator id for this annotation is added to the list of default + validators by a call to jakarta.faces.application.Application#addDefaultValidatorId. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5767 + + boolean + + jakarta.faces.validator.FacesValidator.managed +
+
+
+ The value of this annotation attribute is taken to be an indicator that flags whether + or not the given converter is a CDI managed converter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5768 + + String + + jakarta.faces.validator.FacesValidator.value +
+
+
+ The value of this annotation attribute is taken to be the validator-id with which + instances of this class of component can be instantiated by calling + jakarta.faces.application.Application#createValidator(java.lang.String). If no value is specified, + or the value is null, the value is taken to be the return of calling getSimpleName on the class to + which this annotation is attached and lowercasing the first character. If more than one validator + with this derived name is found, the results are undefined. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5769 + + boolean + + jakarta.faces.validator.FacesValidator.Literal.isDefault +
+
+
+ If true, the validator id for this annotation is added to the list of default + validators by a call to jakarta.faces.application.Application#addDefaultValidatorId. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5770 + + boolean + + jakarta.faces.validator.FacesValidator.Literal.managed +
+
+
+ The value of this annotation attribute is taken to be an indicator that flags whether + or not the given converter is a CDI managed converter. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5771 + + Literal + + jakarta.faces.validator.FacesValidator.Literal.of +
+ ( + String + , +
+ boolean + , +
+ boolean + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5772 + + String + + jakarta.faces.validator.FacesValidator.Literal.value +
+
+
+ The value of this annotation attribute is taken to be the validator-id with which + instances of this class of component can be instantiated by calling + jakarta.faces.application.Application#createValidator(java.lang.String). If no value is specified, + or the value is null, the value is taken to be the return of calling getSimpleName on the class to + which this annotation is attached and lowercasing the first character. If more than one validator + with this derived name is found, the results are undefined. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5773 + + void + + jakarta.faces.validator.LengthValidator.clearInitialState +
+
+
+ Reset the PartialStateHolder to a non-delta tracking state. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5774 + + boolean + + jakarta.faces.validator.LengthValidator.equals +
+ ( + Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5775 + + int + + jakarta.faces.validator.LengthValidator.hashCode +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5776 + + boolean + + jakarta.faces.validator.LengthValidator.initialStateMarked +
+
+
+ Return true if delta state changes are being tracked, otherwise false + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5777 + + boolean + + jakarta.faces.validator.LengthValidator.isTransient +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5778 + + void + + jakarta.faces.validator.LengthValidator.markInitialState +
+
+
+ The runtime must ensure that the #markInitialState method is called on each instance of + this interface in the view at the appropriate time to indicate the component is in its initial + state. The implementor of the interface must ensure that #initialStateMarked returns true from the + time markInitialState() is called until #clearInitialState is called, after which time + initialStateMarked() must return false. Also, during the time that the instance returns true from + initialStateMarked(), the implementation must return only the state that has changed in its + implementation of StateHolder#saveState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5779 + + void + + jakarta.faces.validator.LengthValidator.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5780 + + Object + + jakarta.faces.validator.LengthValidator.saveState +
+ ( + FacesContext + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5781 + + void + + jakarta.faces.validator.LengthValidator.setTransient +
+ ( + boolean + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5782 + + void + + jakarta.faces.validator.LengthValidator.validate +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5783 + + void + + jakarta.faces.validator.LengthValidator.validate +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) + +
+ throws + ValidatorException +
+
+
+ {@inheritDoc} + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5784 + + void + + jakarta.faces.validator.LongRangeValidator.clearInitialState +
+
+
+ Reset the PartialStateHolder to a non-delta tracking state. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5785 + + boolean + + jakarta.faces.validator.LongRangeValidator.equals +
+ ( + Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5786 + + int + + jakarta.faces.validator.LongRangeValidator.hashCode +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5787 + + boolean + + jakarta.faces.validator.LongRangeValidator.initialStateMarked +
+
+
+ Return true if delta state changes are being tracked, otherwise false + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5788 + + boolean + + jakarta.faces.validator.LongRangeValidator.isTransient +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5789 + + void + + jakarta.faces.validator.LongRangeValidator.markInitialState +
+
+
+ The runtime must ensure that the #markInitialState method is called on each instance of + this interface in the view at the appropriate time to indicate the component is in its initial + state. The implementor of the interface must ensure that #initialStateMarked returns true from the + time markInitialState() is called until #clearInitialState is called, after which time + initialStateMarked() must return false. Also, during the time that the instance returns true from + initialStateMarked(), the implementation must return only the state that has changed in its + implementation of StateHolder#saveState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5790 + + void + + jakarta.faces.validator.LongRangeValidator.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5791 + + Object + + jakarta.faces.validator.LongRangeValidator.saveState +
+ ( + FacesContext + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5792 + + void + + jakarta.faces.validator.LongRangeValidator.setTransient +
+ ( + boolean + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5793 + + void + + jakarta.faces.validator.LongRangeValidator.validate +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5794 + + void + + jakarta.faces.validator.LongRangeValidator.validate +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) + +
+ throws + ValidatorException +
+
+
+ {@inheritDoc} + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5795 + + boolean + + jakarta.faces.validator.MethodExpressionValidator.isTransient +
+
+
+ If true, the Object implementing this interface must not participate in state saving or + restoring. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5796 + + MethodExpressionValidator + + jakarta.faces.validator.MethodExpressionValidator.MethodExpressionValidator +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5797 + + MethodExpressionValidator + + jakarta.faces.validator.MethodExpressionValidator.MethodExpressionValidator +
+ ( + MethodExpression + ) +
+
+ Construct a Validator that contains a MethodExpression. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5798 + + void + + jakarta.faces.validator.MethodExpressionValidator.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ Perform any processing required to restore the state from the entries in the state + Object. If the class that implements this interface has references to instances that also implement + StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the + #restoreState method on all those instances as well. If the state argument is null, take no action + and return. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5799 + + Object + + jakarta.faces.validator.MethodExpressionValidator.saveState +
+ ( + FacesContext + ) +
+
+ Gets the state of the instance as a Serializable Object. If the class that implements + this interface has references to instances that implement StateHolder (such as a UIComponent with + event handlers, validators, etc.) this method must call the #saveState method on all those instances + as well. This method must not save the state of children and facets. That is done via the + jakarta.faces.application.StateManager This method must not alter the state of the implementing + object. In other words, after executing this code: Object state = component.saveState(facesContext); + component should be the same as before executing it. The return from this method must be + Serializable + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5800 + + void + + jakarta.faces.validator.MethodExpressionValidator.setTransient +
+ ( + boolean + ) +
+
+ Denotes whether or not the Object implementing this interface must or must not + participate in state saving or restoring. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5801 + + void + + jakarta.faces.validator.MethodExpressionValidator.validate +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5802 + + void + + jakarta.faces.validator.MethodExpressionValidator.validate +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) + +
+ throws + ValidatorException +
+
+
+ {@inheritDoc} + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5803 + + void + + jakarta.faces.validator.RegexValidator.clearInitialState +
+
+
+ Reset the PartialStateHolder to a non-delta tracking state. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5804 + + String + + jakarta.faces.validator.RegexValidator.getPattern +
+
+
+ Return the ValueExpression that yields the regular expression pattern when evaluated. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5805 + + boolean + + jakarta.faces.validator.RegexValidator.initialStateMarked +
+
+
+ Return true if delta state changes are being tracked, otherwise false + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5806 + + boolean + + jakarta.faces.validator.RegexValidator.isTransient +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5807 + + void + + jakarta.faces.validator.RegexValidator.markInitialState +
+
+
+ The runtime must ensure that the #markInitialState method is called on each instance of + this interface in the view at the appropriate time to indicate the component is in its initial + state. The implementor of the interface must ensure that #initialStateMarked returns true from the + time markInitialState() is called until #clearInitialState is called, after which time + initialStateMarked() must return false. Also, during the time that the instance returns true from + initialStateMarked(), the implementation must return only the state that has changed in its + implementation of StateHolder#saveState. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5808 + + RegexValidator + + jakarta.faces.validator.RegexValidator.RegexValidator +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5809 + + void + + jakarta.faces.validator.RegexValidator.restoreState +
+ ( + FacesContext + , +
+ Object + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5810 + + Object + + jakarta.faces.validator.RegexValidator.saveState +
+ ( + FacesContext + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5811 + + void + + jakarta.faces.validator.RegexValidator.setPattern +
+ ( + String + ) +
+
+ The Regular Expression property to validate against. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5812 + + void + + jakarta.faces.validator.RegexValidator.setTransient +
+ ( + boolean + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5813 + + void + + jakarta.faces.validator.RegexValidator.validate +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ Validate a String against a regular expression pattern. The full regex pattern must be + matched in order to pass the validation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5814 + + void + + jakarta.faces.validator.RequiredValidator.validate +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ Verify that the converted object value is not null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5815 + + void + + jakarta.faces.validator.Validator.validate +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) +
+
+ Perform the correctness checks implemented by this Validator against the specified + UIComponent. If any violations are found, a ValidatorException will be thrown containing the + jakarta.faces.application.FacesMessage describing the failure. For a validator to be fully compliant + with Version 2 and later of the specification, it must not fail validation on null or empty values + unless it is specifically intended to address null or empty values. An application-wide is provided + to allow validators designed for Jakarta Faces 1.2 to work with Jakarta Faces 2 and later. The + jakarta.faces.VALIDATE_EMPTY_FIELDS must be set to false to enable this backwards compatibility + behavior. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5816 + + void + + jakarta.faces.validator.Validator.validate +
+ ( + FacesContext + , +
+ UIComponent + , +
+ Object + ) + +
+ throws + ValidatorException +
+
+
+ if validation fails + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5817 + + FacesMessage + + jakarta.faces.validator.ValidatorException.getFacesMessage +
+
+
+ Returns the FacesMessage associated with the exception. If this instance was created + with a constructor that takes Collection, this method returns the first message in the Collection + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5818 + + Collection + + jakarta.faces.validator.ValidatorException.getFacesMessages +
+
+
+ If this instance was created with a constructor that takes Collection, this method + returns the passed collection, otherwise this method returns null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5819 + + ValidatorException + + jakarta.faces.validator.ValidatorException.ValidatorException +
+ ( + FacesMessage + ) +
+
+ Construct a new exception with the specified message and no root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5820 + + ValidatorException + + jakarta.faces.validator.ValidatorException.ValidatorException +
+ ( + Collection + ) +
+
+ Allow this one exception to contain multiple messages. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5821 + + ValidatorException + + jakarta.faces.validator.ValidatorException.ValidatorException +
+ ( + FacesMessage + , +
+ Throwable + ) +
+
+ Construct a new exception with the specified detail message and root cause. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5822 + + ValidatorException + + jakarta.faces.validator.ValidatorException.ValidatorException +
+ ( + Collection + , +
+ Throwable + ) +
+
+ Allow this one exception to contain multiple messages, while passing on the root cause + to the superclass + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5823 + + void + + jakarta.faces.view.AttachedObjectHandler.applyAttachedObject +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Take the argument parent and apply this attached object to it. The action taken varies + with class that implements one of the subinterfaces of this interface. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5824 + + String + + jakarta.faces.view.AttachedObjectHandler.getFor +
+
+
+ Return the value of the "for" attribute specified by the page author on the tag for + this AttachedObjectHandler. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5825 + + String + + jakarta.faces.view.AttachedObjectTarget.getName +
+
+
+ Returns the name by which this attached object target is exposed to the page author. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5826 + + List + + jakarta.faces.view.AttachedObjectTarget.getTargets +
+ ( + UIComponent + ) +
+
+ Returns the List that this AttachedObjectTarget exposes. Each attached object exposed + by the composite component author may point at multiple UIComponent instances within the composite + component. This method is used by the + jakarta.faces.view.ViewDeclarationLanguage#retargetAttachedObjects method to take the appropriate + action on the attached object. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5827 + + String + + jakarta.faces.view.BehaviorHolderAttachedObjectHandler.getEventName +
+
+
+ Return the client event name to which this behavior applies. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5828 + + boolean + + jakarta.faces.view.BehaviorHolderAttachedObjectTarget.isDefaultEvent +
+
+
+ Returns whether the event set on this target is the default event, e.g. as set by a tag + via the "default" attribute. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5829 + + int + + jakarta.faces.view.Location.getColumn +
+
+
+ Return the estimated character column. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5830 + + int + + jakarta.faces.view.Location.getLine +
+
+
+ Return the line number in the page for this location. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5831 + + String + + jakarta.faces.view.Location.getPath +
+
+
+ Return the file path to the page represented by this location. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5832 + + Location + + jakarta.faces.view.Location.Location +
+ ( + String + , +
+ int + , +
+ int + ) +
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5833 + + String + + jakarta.faces.view.Location.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5834 + + UIViewRoot + + jakarta.faces.view.StateManagementStrategy.restoreView +
+ ( + FacesContext + , +
+ String + , +
+ String + ) +
+
+ Restore the state of the view with information in the request. The default + implementation must perform the following algorithm or its semantic equivalent. As in the case of + restore view on an initial request, the view metadata must be restored and properly handled as well. + Obtain the ViewMetadata for the current viewId, and from that call ViewMetadata#createMetadataView. + Store the resultant UIViewRoot in the FacesContext. Obtain the state of the UIViewRoot from the + state Object returned from jakarta.faces.render.ResponseStateManager#getState and pass that to + UIViewRoot#restoreViewScopeState. Build the view from the markup. For all components in the view + that do not have an explicitly assigned id in the markup, the values of those ids must be the same + as on an initial request for this view. This view will not contain any components programmatically + added during the previous lifecycle run, and it will contain components that were programmatically + deleted on the previous lifecycle run. Both of these cases must be handled. Call + jakarta.faces.render.ResponseStateManager#getState to obtain the data structure returned from the + previous call to #saveView. Visit the tree using jakarta.faces.component.UIComponent#visitTree. For + each node, call jakarta.faces.component.UIComponent#restoreState, passing the state saved + corresponding to the current client id. Ensure that any programmatically deleted components are + removed. Ensure any programmatically added components are added. The implementation must ensure that + the jakarta.faces.component.UIComponent#restoreState method is called for each node in the tree, + except for those that were programmatically deleted on the previous run through the lifecycle. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5835 + + Object + + jakarta.faces.view.StateManagementStrategy.saveView +
+ ( + FacesContext + ) +
+
+ Return the state of the current view in an Object that implements Serializable and can + be passed to java.io.ObjectOutputStream.writeObject() without causing a + java.io.NotSerializableException to be thrown. The default implementation must perform the following + algorithm or its semantic equivalent, explicitly performing all the steps listed here. If the + UIViewRoot of the current view is marked transient, return null immediately. Traverse the view and + verify that each of the client ids are unique. Throw IllegalStateException if more than one client + id are the same. Visit the tree using jakarta.faces.component.UIComponent#visitTree. For each node, + call jakarta.faces.component.UIComponent#saveState, saving the returned Object in a way such that it + can be restored given only its client id. Special care must be taken to handle the case of + components that were added or deleted programmatically during this lifecycle traversal, rather than + by the VDL. The implementation must ensure that the jakarta.faces.component.UIComponent#saveState + method is called for each node in the tree. The data structure used to save the state obtained by + executing the above algorithm must be Serializable, and all of the elements within the data + structure must also be Serializable. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5836 + + StateManagementStrategy + + jakarta.faces.view.StateManagementStrategy.StateManagementStrategy +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5837 + + void + + jakarta.faces.view.ViewDeclarationLanguage.buildView +
+ ( + FacesContext + , +
+ UIViewRoot + ) +
+
+ Take any actions specific to this VDL implementation to cause the argument UIViewRoot + which must have been created via a call to #createView, to be populated with children. The Facelets + implementation must insure that markup comprising the view must be executed, with the + jakarta.faces.component.UIComponent instances in the view being encountered in the same depth-first + order as in other lifecycle methods defined on UIComponent, and added to the view (but not rendered) + during the traversal. The runtime must guarantee that the view must be fully populated before any of + the following happen. The jakarta.faces.event.PhaseListener#afterPhase method of any PhaseListeners + attached to the application is called The jakarta.faces.component.UIViewRoot phase listener + installed via jakarta.faces.component.UIViewRoot#setAfterPhaseListener or + jakarta.faces.component.UIViewRoot#addPhaseListener are called. If the root is already populated + with children, the view must still be re-built, but care must be taken to ensure that the existing + components are correctly paired up with their VDL counterparts in the VDL page. Also, any system + events that would normally be generated during the adding or removing of components from the view + must be temporarily disabled during the creation of the view and then re-enabled when the view has + been built. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5838 + + void + + jakarta.faces.view.ViewDeclarationLanguage.buildView +
+ ( + FacesContext + , +
+ UIViewRoot + ) + +
+ throws + IOException +
+
+
+ if view cannot be built for any reason + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5839 + + List + + jakarta.faces.view.ViewDeclarationLanguage.calculateResourceLibraryContracts +
+ ( + FacesContext + , +
+ String + ) +
+
+ Return the list of resource library contracts that will be made available for use in + the view specified by the argument viewId. If no match is found, return an empty list. See section + 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document + for the specification of the default implementation. For backward compatibility with prior + implementations, an implementation is provided that returns null, but any implementation compliant + with the version of the specification in which this method was introduced must implement it as + specified in section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces + Specification Document. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5840 + + UIComponent + + jakarta.faces.view.ViewDeclarationLanguage.createComponent +
+ ( + FacesContext + , +
+ String + , +
+ String + , +
+ Map + ) +
+
+ Create a component given a ViewDeclarationLanguage specific tag library URI and tag + name. The runtime must support this method operating for the Facelets VDL. Other kinds of + ViewDeclarationLanguage may be supported but are not required to be supported. For backward + compatibility with decorated ViewDeclrationLanguage implementations that do not override this + method, a default implementation is provided that returns null. However, any implementation that is + compliant with the version of the specification in which this method was introduced must implement + this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5841 + + UIViewRoot + + jakarta.faces.view.ViewDeclarationLanguage.createView +
+ ( + FacesContext + , +
+ String + ) +
+
+ Create a UIViewRoot from the VDL contained in the artifact referenced by the argument + viewId. See section 7.7.2"Default ViewDeclarationLanguage Implementation" of the Jakarta Faces + Specification Document for the specification of the default implementation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5842 + + BeanInfo + + jakarta.faces.view.ViewDeclarationLanguage.getComponentMetadata +
+ ( + FacesContext + , +
+ Resource + ) +
+
+ Return a reference to the component metadata for the composite component represented by + the argument componentResource, or null if the metadata cannot be found. See section 7.7.2 "Default + ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the + specification of the default implementation. Jakarta Server Pages implementations must throw + UnsupportedOperationException. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5843 + + String + + jakarta.faces.view.ViewDeclarationLanguage.getId +
+
+
+ Returns a non-null String that can be used to identify this view declaration language. + The default implementation returns the fully qualified class name of the view declaration language + implementation. Subclasses may override to provide a more meaningful id. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5844 + + Resource + + jakarta.faces.view.ViewDeclarationLanguage.getScriptComponentResource +
+ ( + FacesContext + , +
+ Resource + ) +
+
+ Take implementation specific action to discover a Resource given the argument + componentResource. See section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta + Faces Specification Document for the specification of the default implementation. Jakarta Server + Pages implementations must throw UnsupportedOperationException. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5845 + + StateManagementStrategy + + jakarta.faces.view.ViewDeclarationLanguage.getStateManagementStrategy +
+ ( + FacesContext + , +
+ String + ) +
+
+ For implementations that want to control the implementation of state saving and + restoring, the StateManagementStrategy allows them to do so. Returning null indicates that the + implementation wishes the runtime to handle the state saving and restoring. Implementations that + provide the VDL for Facelets for Jakarta Faces 2.0 and later must return non-null from this method. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5846 + + ViewMetadata + + jakarta.faces.view.ViewDeclarationLanguage.getViewMetadata +
+ ( + FacesContext + , +
+ String + ) +
+
+ Return a reference to the view metadata for the view represented by the argument + viewId, or null if the metadata cannot be found. See section 7.7.2 "Default ViewDeclarationLanguage + Implementation" of the Jakarta Faces Specification Document for the specification of the default + implementation. Facelets implementation must return non-null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5847 + + Stream + + jakarta.faces.view.ViewDeclarationLanguage.getViews +
+ ( + FacesContext + , +
+ String + , +
+ ViewVisitOption[] + ) +
+
+ Return a Stream possibly lazily populated by walking the view tree rooted at a given + initial path. The view tree is traversed breadth-first, the elements in the stream are logical view + ids. This method works as if invoking it were equivalent to evaluating the expression: + getViewResources(facesContext, start, Integer.MAX_VALUE, options) Put differently, it visits all + levels of the resource tree. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5848 + + Stream + + jakarta.faces.view.ViewDeclarationLanguage.getViews +
+ ( + FacesContext + , +
+ String + , +
+ int + , +
+ ViewVisitOption[] + ) +
+
+ Return a Stream possibly lazily populated by walking the view tree rooted at a given + initial path. The view tree is traversed breadth-first, the elements in the stream are logical view + ids. The maxDepth parameter is the maximum depth of directory levels to visit beyond the initial + path, which is always visited. The value is relative to the root (/), not to the given initial path. + E.g. given maxDepth = 3 and initial path /foo/, visiting will proceed up to /foo/bar/, where / + counts as depth 1, /foo/ as depth 2 and /foo/bar/ as depth 3. A value lower or equal to the depth of + the initial path means that only the initial path is visited. A value of Integer#MAX_VALUE MAX_VALUE + may be used to indicate that all levels should be visited. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5849 + + void + + jakarta.faces.view.ViewDeclarationLanguage.renderView +
+ ( + FacesContext + , +
+ UIViewRoot + ) +
+
+ Render a view rooted at argumentview. See section 7.7.2 "Default + ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the + specification of the default implementation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5850 + + void + + jakarta.faces.view.ViewDeclarationLanguage.renderView +
+ ( + FacesContext + , +
+ UIViewRoot + ) + +
+ throws + IOException +
+
+
+ if the view cannot be rendered for any reason + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5851 + + UIViewRoot + + jakarta.faces.view.ViewDeclarationLanguage.restoreView +
+ ( + FacesContext + , +
+ String + ) +
+
+ Restore a UIViewRoot from a previously created view. See section 7.7.2 "Default + ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the + specification of the default implementation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5852 + + void + + jakarta.faces.view.ViewDeclarationLanguage.retargetAttachedObjects +
+ ( + FacesContext + , +
+ UIComponent + , +
+ List + ) +
+
+ Assuming the component metadata for argument topLevelComponent has been made available + by an earlier call to ViewDeclarationLanguage#getComponentMetadata, leverage the component metadata + for the purpose of re-targeting attached objects from the top level composite component to the + individual AttachedObjectTarget instances inside the composite component. This method must be called + by the ViewDeclarationLanguage implementation when creating the UIComponent tree when a composite + component usage is encountered. An algorithm semantically equivalent to the following must be + implemented. Obtain the metadata for the composite component. Currently this entails getting the + value of the UIComponent#BEANINFO_KEY component attribute, which will be an instance of BeanInfo. If + the metadata cannot be found, log an error message and return. Get the BeanDescriptor from the + BeanInfo. Get the value of the AttachedObjectTarget#ATTACHED_OBJECT_TARGETS_KEY from the + BeanDescriptor's getValue() method. This will be a List lt;AttachedObjectTarget gt;. Let this be + targetList. For each curHandler entry in the argument handlers Let forAttributeValue be the return + from AttachedObjectHandler#getFor. For each curTarget entry in targetList, the first of the + following items that causes a match will take this action: For each UIComponent in the list returned + from curTarget.getTargets(), call curHandler.applyAttachedObject(), passing the FacesContext and the + UIComponent. and cause this inner loop to terminate. If curHandler is an instance of + ActionSource2AttachedObjectHandler and curTarget is an instance of + ActionSource2AttachedObjectTarget, and curTarget.getName() is equal to curTargetName, consider it a + match. If curHandler is an instance of EditableValueHolderAttachedObjectHandler and curTarget is an + instance of EditableValueHolderAttachedObjectTarget, and curTarget.getName() is equal to + curTargetName, consider it a match. If curHandler is an instance of ValueHolderAttachedObjectHandler + and curTarget is an instance of ValueHolderAttachedObjectTarget, and curTarget.getName() is equal to + curTargetName, consider it a match. If curHandler is an instance of + BehaviorHolderAttachedObjectHandler and curTarget is an instance of + BehaviorHolderAttachedObjectTarget, and either of the following conditions are true, + curHandler.getEventName() is not null and is equal to curTargetName. curHandler.getEventName() is + null and curTarget.isDefaultEvent() is true. consider it a match. The implementation must support + retargeting attached objects from the top level compsite component to targets that are composite and + non-composite components. An implementation is provided that will throw + UnsupportedOperationException. A Faces implementation compliant with version 2.0 and beyond of the + specification must override this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5853 + + void + + jakarta.faces.view.ViewDeclarationLanguage.retargetMethodExpressions +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Assuming the component metadata for argument topLevelComponent has been made available + by an earlier call to ViewDeclarationLanguage#getComponentMetadata, leverage the component metadata + for the purpose of re-targeting any method expressions from the top level component to the + appropriate inner component. For each attribute that is a MethodExpression (as indicated by the + presence of a "method-signature" attribute and the absence of a "type" attribute), the following + action must be taken: Get the value of the targets attribute. If the value is a ValueExpression + evaluate it. If there is no targets attribute, let the name of the metadata element be the evaluated + value of the targets attribute. Interpret targets as a space (not tab) separated list of ids. For + each entry in the list: Find the inner component of the topLevelComponent with the id equal to the + current list entry. For discussion, this component is called target. If not found, log and error and + continue to the next attribute. For discussion the declared name of the attribute is called name. In + the attributes map of the topLevelComponent, look up the entry under the key name. Assume the result + is a ValueExpression. For discussion, this is attributeValueExpression. If not found, log an error + and continue to the next attribute. If name is equal to the string "action", or "actionListener" + without the quotes, assume target is an jakarta.faces.component.ActionSource2. If name is equal to + the string "validator", or "valueChangeListener" without the quotes, assume target is an + jakarta.faces.component.EditableValueHolder. Call getExpressionString() on the + attributeValueExpression and use that string to create a MethodExpression of the appropriate + signature for name. If name is not equal to any of the previously listed strings, call + getExpressionString() on the attributeValueExpression and use that string to create a + MethodExpression where the signature is created based on the value of the "method-signature" + attribute of the tag. Let the resultant MethodExpression be called attributeMethodExpression for + discussion. If name is equal to the string "action" without the quotes, call + jakarta.faces.component.ActionSource2#setActionExpression on target, passing + attributeMethodExpression. If name is equal to the string "actionListener" without the quotes, call + jakarta.faces.component.ActionSource#addActionListener on target, passing attributeMethodExpression + wrapped in a jakarta.faces.event.MethodExpressionActionListener. If name is equal to the string + "validator" without the quotes, call jakarta.faces.component.EditableValueHolder#addValidator on + target, passing attributeMethodExpression wrapped in a + jakarta.faces.validator.MethodExpressionValidator. If name is equal to the string + "valueChangeListener" without the quotes, call + jakarta.faces.component.EditableValueHolder#addValueChangeListener on target, passing + attributeMethodExpression wrapped in a jakarta.faces.event.MethodExpressionValueChangeListener. + Otherwise, assume that the MethodExpression should be placed in the components attribute set. The + runtme must create the MethodExpression instance based on the value of the "method-signature" + attribute. An implementation is provided that will throw UnsupportedOperationException. A Faces + implementation compliant with version 2.0 and beyond of the specification must override this method. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5854 + + ViewDeclarationLanguage + + jakarta.faces.view.ViewDeclarationLanguage.ViewDeclarationLanguage +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5855 + + boolean + + jakarta.faces.view.ViewDeclarationLanguage.viewExists +
+ ( + FacesContext + , +
+ String + ) +
+
+ Tests whether a physical resource corresponding to the specified viewId exists. The + default implementation uses jakarta.faces.application.ResourceHandler#createViewResource to locate + the physical resource. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5856 + + List + + jakarta.faces.view.ViewDeclarationLanguageFactory.getAllViewDeclarationLanguages +
+
+
+ Gets the list of all view declaration languages supported by this runtime. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5857 + + ViewDeclarationLanguage + + jakarta.faces.view.ViewDeclarationLanguageFactory.getViewDeclarationLanguage +
+ ( + String + ) +
+
+ Return the ViewDeclarationLanguage instance suitable for handling the VDL contained in + the page referenced by the argument viewId. The default implementation must return a valid + ViewDeclarationLanguage instance for views written in either Jakarta Server Pages, Faces XML Views, + or Facelets for Jakarta Faces 2. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5858 + + ViewDeclarationLanguageFactory + + jakarta.faces.view.ViewDeclarationLanguageFactory.getWrapped +
+
+
+ If this factory has been decorated, the implementation doing the decorating may + override this method to provide access to the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5859 + + ViewDeclarationLanguageFactory + + jakarta.faces.view.ViewDeclarationLanguageFactory.ViewDeclarationLanguageFactory +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:5860 + + ViewDeclarationLanguageFactory + + jakarta.faces.view.ViewDeclarationLanguageFactory.ViewDeclarationLanguageFactory +
+ ( + ViewDeclarationLanguageFactory + ) +
+
+ If this factory has been decorated, the implementation doing the decorating should push + the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5861 + + void + + jakarta.faces.view.ViewDeclarationLanguageWrapper.buildView +
+ ( + FacesContext + , +
+ UIViewRoot + ) +
+
+ Take any actions specific to this VDL implementation to cause the argument UIViewRoot + which must have been created via a call to #createView, to be populated with children. The Facelets + implementation must insure that markup comprising the view must be executed, with the + jakarta.faces.component.UIComponent instances in the view being encountered in the same depth-first + order as in other lifecycle methods defined on UIComponent, and added to the view (but not rendered) + during the traversal. The runtime must guarantee that the view must be fully populated before any of + the following happen. The jakarta.faces.event.PhaseListener#afterPhase method of any PhaseListeners + attached to the application is called The jakarta.faces.component.UIViewRoot phase listener + installed via jakarta.faces.component.UIViewRoot#setAfterPhaseListener or + jakarta.faces.component.UIViewRoot#addPhaseListener are called. If the root is already populated + with children, the view must still be re-built, but care must be taken to ensure that the existing + components are correctly paired up with their VDL counterparts in the VDL page. Also, any system + events that would normally be generated during the adding or removing of components from the view + must be temporarily disabled during the creation of the view and then re-enabled when the view has + been built. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5862 + + void + + jakarta.faces.view.ViewDeclarationLanguageWrapper.buildView +
+ ( + FacesContext + , +
+ UIViewRoot + ) + +
+ throws + IOException +
+
+
+ if view cannot be built for any reason + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5863 + + List + + jakarta.faces.view.ViewDeclarationLanguageWrapper.calculateResourceLibraryContracts +
+ ( + FacesContext + , +
+ String + ) +
+
+ Return the list of resource library contracts that will be made available for use in + the view specified by the argument viewId. If no match is found, return an empty list. See section + 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document + for the specification of the default implementation. For backward compatibility with prior + implementations, an implementation is provided that returns null, but any implementation compliant + with the version of the specification in which this method was introduced must implement it as + specified in section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces + Specification Document. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5864 + + UIComponent + + jakarta.faces.view.ViewDeclarationLanguageWrapper.createComponent +
+ ( + FacesContext + , +
+ String + , +
+ String + , +
+ Map + ) +
+
+ Create a component given a ViewDeclarationLanguage specific tag library URI and tag + name. The runtime must support this method operating for the Facelets VDL. Other kinds of + ViewDeclarationLanguage may be supported but are not required to be supported. For backward + compatibility with decorated ViewDeclrationLanguage implementations that do not override this + method, a default implementation is provided that returns null. However, any implementation that is + compliant with the version of the specification in which this method was introduced must implement + this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5865 + + UIViewRoot + + jakarta.faces.view.ViewDeclarationLanguageWrapper.createView +
+ ( + FacesContext + , +
+ String + ) +
+
+ Create a UIViewRoot from the VDL contained in the artifact referenced by the argument + viewId. See section 7.7.2"Default ViewDeclarationLanguage Implementation" of the Jakarta Faces + Specification Document for the specification of the default implementation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5866 + + BeanInfo + + jakarta.faces.view.ViewDeclarationLanguageWrapper.getComponentMetadata +
+ ( + FacesContext + , +
+ Resource + ) +
+
+ Return a reference to the component metadata for the composite component represented by + the argument componentResource, or null if the metadata cannot be found. See section 7.7.2 "Default + ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the + specification of the default implementation. Jakarta Server Pages implementations must throw + UnsupportedOperationException. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5867 + + String + + jakarta.faces.view.ViewDeclarationLanguageWrapper.getId +
+
+
+ Returns a non-null String that can be used to identify this view declaration language. + The default implementation returns the fully qualified class name of the view declaration language + implementation. Subclasses may override to provide a more meaningful id. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5868 + + Resource + + jakarta.faces.view.ViewDeclarationLanguageWrapper.getScriptComponentResource +
+ ( + FacesContext + , +
+ Resource + ) +
+
+ Take implementation specific action to discover a Resource given the argument + componentResource. See section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta + Faces Specification Document for the specification of the default implementation. Jakarta Server + Pages implementations must throw UnsupportedOperationException. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5869 + + StateManagementStrategy + + jakarta.faces.view.ViewDeclarationLanguageWrapper.getStateManagementStrategy +
+ ( + FacesContext + , +
+ String + ) +
+
+ For implementations that want to control the implementation of state saving and + restoring, the StateManagementStrategy allows them to do so. Returning null indicates that the + implementation wishes the runtime to handle the state saving and restoring. Implementations that + provide the VDL for Facelets for Jakarta Faces 2.0 and later must return non-null from this method. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5870 + + ViewMetadata + + jakarta.faces.view.ViewDeclarationLanguageWrapper.getViewMetadata +
+ ( + FacesContext + , +
+ String + ) +
+
+ Return a reference to the view metadata for the view represented by the argument + viewId, or null if the metadata cannot be found. See section 7.7.2 "Default ViewDeclarationLanguage + Implementation" of the Jakarta Faces Specification Document for the specification of the default + implementation. Facelets implementation must return non-null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5871 + + Stream + + jakarta.faces.view.ViewDeclarationLanguageWrapper.getViews +
+ ( + FacesContext + , +
+ String + , +
+ ViewVisitOption[] + ) +
+
+ Return a Stream possibly lazily populated by walking the view tree rooted at a given + initial path. The view tree is traversed breadth-first, the elements in the stream are logical view + ids. This method works as if invoking it were equivalent to evaluating the expression: + getViewResources(facesContext, start, Integer.MAX_VALUE, options) Put differently, it visits all + levels of the resource tree. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5872 + + Stream + + jakarta.faces.view.ViewDeclarationLanguageWrapper.getViews +
+ ( + FacesContext + , +
+ String + , +
+ int + , +
+ ViewVisitOption[] + ) +
+
+ Return a Stream possibly lazily populated by walking the view tree rooted at a given + initial path. The view tree is traversed breadth-first, the elements in the stream are logical view + ids. The maxDepth parameter is the maximum depth of directory levels to visit beyond the initial + path, which is always visited. The value is relative to the root (/), not to the given initial path. + E.g. given maxDepth = 3 and initial path /foo/, visiting will proceed up to /foo/bar/, where / + counts as depth 1, /foo/ as depth 2 and /foo/bar/ as depth 3. A value lower or equal to the depth of + the initial path means that only the initial path is visited. A value of Integer#MAX_VALUE MAX_VALUE + may be used to indicate that all levels should be visited. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5873 + + ViewDeclarationLanguage + + jakarta.faces.view.ViewDeclarationLanguageWrapper.getWrapped +
+
+
+ A class that implements this interface uses this method to return an instance of the + class being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5874 + + void + + jakarta.faces.view.ViewDeclarationLanguageWrapper.renderView +
+ ( + FacesContext + , +
+ UIViewRoot + ) +
+
+ Render a view rooted at argumentview. See section 7.7.2 "Default + ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the + specification of the default implementation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5875 + + void + + jakarta.faces.view.ViewDeclarationLanguageWrapper.renderView +
+ ( + FacesContext + , +
+ UIViewRoot + ) + +
+ throws + IOException +
+
+
+ if the view cannot be rendered for any reason + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5876 + + UIViewRoot + + jakarta.faces.view.ViewDeclarationLanguageWrapper.restoreView +
+ ( + FacesContext + , +
+ String + ) +
+
+ Restore a UIViewRoot from a previously created view. See section 7.7.2 "Default + ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the + specification of the default implementation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5877 + + void + + jakarta.faces.view.ViewDeclarationLanguageWrapper.retargetAttachedObjects +
+ ( + FacesContext + , +
+ UIComponent + , +
+ List + ) +
+
+ Assuming the component metadata for argument topLevelComponent has been made available + by an earlier call to ViewDeclarationLanguage#getComponentMetadata, leverage the component metadata + for the purpose of re-targeting attached objects from the top level composite component to the + individual AttachedObjectTarget instances inside the composite component. This method must be called + by the ViewDeclarationLanguage implementation when creating the UIComponent tree when a composite + component usage is encountered. An algorithm semantically equivalent to the following must be + implemented. Obtain the metadata for the composite component. Currently this entails getting the + value of the UIComponent#BEANINFO_KEY component attribute, which will be an instance of BeanInfo. If + the metadata cannot be found, log an error message and return. Get the BeanDescriptor from the + BeanInfo. Get the value of the AttachedObjectTarget#ATTACHED_OBJECT_TARGETS_KEY from the + BeanDescriptor's getValue() method. This will be a List lt;AttachedObjectTarget gt;. Let this be + targetList. For each curHandler entry in the argument handlers Let forAttributeValue be the return + from AttachedObjectHandler#getFor. For each curTarget entry in targetList, the first of the + following items that causes a match will take this action: For each UIComponent in the list returned + from curTarget.getTargets(), call curHandler.applyAttachedObject(), passing the FacesContext and the + UIComponent. and cause this inner loop to terminate. If curHandler is an instance of + ActionSource2AttachedObjectHandler and curTarget is an instance of + ActionSource2AttachedObjectTarget, and curTarget.getName() is equal to curTargetName, consider it a + match. If curHandler is an instance of EditableValueHolderAttachedObjectHandler and curTarget is an + instance of EditableValueHolderAttachedObjectTarget, and curTarget.getName() is equal to + curTargetName, consider it a match. If curHandler is an instance of ValueHolderAttachedObjectHandler + and curTarget is an instance of ValueHolderAttachedObjectTarget, and curTarget.getName() is equal to + curTargetName, consider it a match. If curHandler is an instance of + BehaviorHolderAttachedObjectHandler and curTarget is an instance of + BehaviorHolderAttachedObjectTarget, and either of the following conditions are true, + curHandler.getEventName() is not null and is equal to curTargetName. curHandler.getEventName() is + null and curTarget.isDefaultEvent() is true. consider it a match. The implementation must support + retargeting attached objects from the top level compsite component to targets that are composite and + non-composite components. An implementation is provided that will throw + UnsupportedOperationException. A Faces implementation compliant with version 2.0 and beyond of the + specification must override this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5878 + + void + + jakarta.faces.view.ViewDeclarationLanguageWrapper.retargetMethodExpressions +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Assuming the component metadata for argument topLevelComponent has been made available + by an earlier call to ViewDeclarationLanguage#getComponentMetadata, leverage the component metadata + for the purpose of re-targeting any method expressions from the top level component to the + appropriate inner component. For each attribute that is a MethodExpression (as indicated by the + presence of a "method-signature" attribute and the absence of a "type" attribute), the following + action must be taken: Get the value of the targets attribute. If the value is a ValueExpression + evaluate it. If there is no targets attribute, let the name of the metadata element be the evaluated + value of the targets attribute. Interpret targets as a space (not tab) separated list of ids. For + each entry in the list: Find the inner component of the topLevelComponent with the id equal to the + current list entry. For discussion, this component is called target. If not found, log and error and + continue to the next attribute. For discussion the declared name of the attribute is called name. In + the attributes map of the topLevelComponent, look up the entry under the key name. Assume the result + is a ValueExpression. For discussion, this is attributeValueExpression. If not found, log an error + and continue to the next attribute. If name is equal to the string "action", or "actionListener" + without the quotes, assume target is an jakarta.faces.component.ActionSource2. If name is equal to + the string "validator", or "valueChangeListener" without the quotes, assume target is an + jakarta.faces.component.EditableValueHolder. Call getExpressionString() on the + attributeValueExpression and use that string to create a MethodExpression of the appropriate + signature for name. If name is not equal to any of the previously listed strings, call + getExpressionString() on the attributeValueExpression and use that string to create a + MethodExpression where the signature is created based on the value of the "method-signature" + attribute of the tag. Let the resultant MethodExpression be called attributeMethodExpression for + discussion. If name is equal to the string "action" without the quotes, call + jakarta.faces.component.ActionSource2#setActionExpression on target, passing + attributeMethodExpression. If name is equal to the string "actionListener" without the quotes, call + jakarta.faces.component.ActionSource#addActionListener on target, passing attributeMethodExpression + wrapped in a jakarta.faces.event.MethodExpressionActionListener. If name is equal to the string + "validator" without the quotes, call jakarta.faces.component.EditableValueHolder#addValidator on + target, passing attributeMethodExpression wrapped in a + jakarta.faces.validator.MethodExpressionValidator. If name is equal to the string + "valueChangeListener" without the quotes, call + jakarta.faces.component.EditableValueHolder#addValueChangeListener on target, passing + attributeMethodExpression wrapped in a jakarta.faces.event.MethodExpressionValueChangeListener. + Otherwise, assume that the MethodExpression should be placed in the components attribute set. The + runtme must create the MethodExpression instance based on the value of the "method-signature" + attribute. An implementation is provided that will throw UnsupportedOperationException. A Faces + implementation compliant with version 2.0 and beyond of the specification must override this method. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5879 + + ViewDeclarationLanguageWrapper + + jakarta.faces.view.ViewDeclarationLanguageWrapper.ViewDeclarationLanguageWrapper +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:5880 + + ViewDeclarationLanguageWrapper + + jakarta.faces.view.ViewDeclarationLanguageWrapper.ViewDeclarationLanguageWrapper +
+ ( + ViewDeclarationLanguage + ) +
+
+ If this view declaration language has been decorated, the implementation doing the + decorating should push the implementation being wrapped to this constructor. The #getWrapped() will + then return the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5881 + + boolean + + jakarta.faces.view.ViewDeclarationLanguageWrapper.viewExists +
+ ( + FacesContext + , +
+ String + ) +
+
+ Tests whether a physical resource corresponding to the specified viewId exists. The + default implementation uses jakarta.faces.application.ResourceHandler#createViewResource to locate + the physical resource. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5882 + + UIViewRoot + + jakarta.faces.view.ViewMetadata.createMetadataView +
+ ( + FacesContext + ) +
+
+ Creates a new UIViewRoot containing only view parameter metadata. The processing of + building this UIViewRoot with metadata should not cause any events to be published to the + application. The implementation must call FacesContext#setProcessingEvents passing false as the + argument, at the beginning of the method, and pass true to the same method at the end. The + implementation must ensure that this happens regardless of ant exceptions that may be thrown. Take + note a compliant implementation has to ensure that: the new UIViewRoot must be set as the + FacesContext's viewRoot before applying the tag handlers, restoring the old FacesContext in a + finally block. The contents of the current UIViewRoot's ViewMap must be copied to the ViewMap of the + new UIViewRoot before applying the tag handlers. The UIImportConstants must be processed after + applying the tag handlers. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5883 + + Collection + + jakarta.faces.view.ViewMetadata.getImportConstants +
+ ( + UIViewRoot + ) +
+
+ Utility method to extract view metadata from the provided UIViewRoot. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5884 + + Collection + + jakarta.faces.view.ViewMetadata.getViewActions +
+ ( + UIViewRoot + ) +
+
+ Utility method to extract view metadata from the provided UIViewRoot. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5885 + + String + + jakarta.faces.view.ViewMetadata.getViewId +
+
+
+ Get the view id + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5886 + + Collection + + jakarta.faces.view.ViewMetadata.getViewParameters +
+ ( + UIViewRoot + ) +
+
+ Utility method to extract view metadata from the provided UIViewRoot. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5887 + + boolean + + jakarta.faces.view.ViewMetadata.hasMetadata +
+ ( + UIViewRoot + ) +
+
+ Utility method to determine if the the provided UIViewRoot has metadata. The default + implementation will return true if the provided UIViewRoot has a facet named + UIViewRoot#METADATA_FACET_NAME and that facet has children. It will return false otherwise. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5888 + + ViewMetadata + + jakarta.faces.view.ViewMetadata.ViewMetadata +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5889 + + String + + jakarta.faces.view.facelets.AttributeHandler.getAttributeName +
+ ( + FaceletContext + ) +
+
+ Returns the resolved literal String value of the attribute name after evaluating EL. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5890 + + String + + jakarta.faces.view.facelets.BehaviorConfig.getBehaviorId +
+
+
+ Return the value of the behavior-id. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5891 + + BehaviorHandler + + jakarta.faces.view.facelets.BehaviorHandler.BehaviorHandler +
+ ( + BehaviorConfig + ) +
+
+ Constructs the handler using the Id from the config. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5892 + + String + + jakarta.faces.view.facelets.BehaviorHandler.getBehaviorId +
+
+
+ Returns the behavior Id obtained from the passed-in config. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5893 + + TagAttribute + + jakarta.faces.view.facelets.BehaviorHandler.getEvent +
+
+
+ Returns the event that is set as the "event" attribute on the behavior tag. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5894 + + String + + jakarta.faces.view.facelets.BehaviorHandler.getEventName +
+
+
+ Return the client event name to which this behavior applies. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5895 + + String + + jakarta.faces.view.facelets.ComponentConfig.getComponentType +
+
+
+ ComponentType to pass to the Application. Cannot be null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5896 + + String + + jakarta.faces.view.facelets.ComponentConfig.getRendererType +
+
+
+ RendererType to set on created UIComponent instances. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5897 + + ComponentHandler + + jakarta.faces.view.facelets.ComponentHandler.ComponentHandler +
+ ( + ComponentConfig + ) +
+
+ Leverage the TagHandlerDelegateFactory provided by the implementation to create an + instance of TagHandlerDelegate designed for use with ComponentHandler. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5898 + + UIComponent + + jakarta.faces.view.facelets.ComponentHandler.createComponent +
+ ( + FaceletContext + ) +
+
+ Subclasses that wish to take over the task of instantiating the UIComponent instance + corresponding to this tag handler my override this method to do so. A null return from this method + will cause the TagHandlerDelegate for instance to create the component instead. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5899 + + ComponentConfig + + jakarta.faces.view.facelets.ComponentHandler.getComponentConfig +
+
+
+ Returns the component configuration, a component-type/renderer-type pair. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5900 + + boolean + + jakarta.faces.view.facelets.ComponentHandler.isNew +
+ ( + UIComponent + ) +
+
+ Determine if the passed component is not null and if it's new to the tree. This + operation can be used for determining if attributes should be wired to the component. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5901 + + void + + jakarta.faces.view.facelets.ComponentHandler.onComponentCreated +
+ ( + FaceletContext + , +
+ UIComponent + , +
+ UIComponent + ) +
+
+ This method is guaranteed to be called after the component has been created but before + it has been populated with children. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5902 + + void + + jakarta.faces.view.facelets.ComponentHandler.onComponentPopulated +
+ ( + FaceletContext + , +
+ UIComponent + , +
+ UIComponent + ) +
+
+ This method is guaranteed to be called after the component has been populated with + children. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5903 + + void + + jakarta.faces.view.facelets.CompositeFaceletHandler.apply +
+ ( + FaceletContext + , +
+ UIComponent + ) +
+
+ Calls apply on any child handlers. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5904 + + void + + jakarta.faces.view.facelets.CompositeFaceletHandler.apply +
+ ( + FaceletContext + , +
+ UIComponent + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5905 + + CompositeFaceletHandler + + jakarta.faces.view.facelets.CompositeFaceletHandler.CompositeFaceletHandler +
+ ( + FaceletHandler[] + ) +
+
+ Creates a new FaceletHandler out of the given inner FaceletHandlers. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5906 + + FaceletHandler[] + + jakarta.faces.view.facelets.CompositeFaceletHandler.getHandlers +
+
+
+ Returns the array of child handlers contained by this handler. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5907 + + String + + jakarta.faces.view.facelets.ConverterConfig.getConverterId +
+
+
+ Return the converter id to be used in instantiating this converter + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5908 + + ConverterHandler + + jakarta.faces.view.facelets.ConverterHandler.ConverterHandler +
+ ( + ConverterConfig + ) +
+
+ Creates a new ConverterHandler using the given config. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5909 + + String + + jakarta.faces.view.facelets.ConverterHandler.getConverterId +
+ ( + FaceletContext + ) +
+
+ Returns the converter Id. The converter Id is taken from the attribute "converterId" + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5910 + + void + + jakarta.faces.view.facelets.DelegatingMetaTagHandler.apply +
+ ( + FaceletContext + , +
+ UIComponent + ) +
+
+ The default implementation simply calls through to TagHandlerDelegate#apply. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5911 + + void + + jakarta.faces.view.facelets.DelegatingMetaTagHandler.apply +
+ ( + FaceletContext + , +
+ UIComponent + ) + +
+ throws + IOException +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5912 + + void + + jakarta.faces.view.facelets.DelegatingMetaTagHandler.applyNextHandler +
+ ( + FaceletContext + , +
+ UIComponent + ) +
+
+ Invoke the apply() method on this instance's TagHandler#nextHandler. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5913 + + void + + jakarta.faces.view.facelets.DelegatingMetaTagHandler.applyNextHandler +
+ ( + FaceletContext + , +
+ UIComponent + ) + +
+ throws + IOException +
+
+
+ if thrown by the next FaceletHandler + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5914 + + void + + jakarta.faces.view.facelets.DelegatingMetaTagHandler.applyNextHandler +
+ ( + FaceletContext + , +
+ UIComponent + ) + +
+ throws + FacesException +
+
+
+ if thrown by the next FaceletHandler + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5915 + + void + + jakarta.faces.view.facelets.DelegatingMetaTagHandler.applyNextHandler +
+ ( + FaceletContext + , +
+ UIComponent + ) + +
+ throws + ELException +
+
+
+ if thrown by the next FaceletHandler + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5916 + + DelegatingMetaTagHandler + + jakarta.faces.view.facelets.DelegatingMetaTagHandler.DelegatingMetaTagHandler +
+ ( + TagConfig + ) +
+
+ Instantiates this handler with the given config. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5917 + + TagAttribute + + jakarta.faces.view.facelets.DelegatingMetaTagHandler.getBinding +
+
+
+ Return the "binding" attribute. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5918 + + Tag + + jakarta.faces.view.facelets.DelegatingMetaTagHandler.getTag +
+
+
+ Return a reference to the Tag instance corresponding to this TagHandler instance. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5919 + + TagAttribute + + jakarta.faces.view.facelets.DelegatingMetaTagHandler.getTagAttribute +
+ ( + String + ) +
+
+ Return the named attribute from the tag attributes. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5920 + + String + + jakarta.faces.view.facelets.DelegatingMetaTagHandler.getTagId +
+
+
+ Return the tag id from the TagConfig used to instantiate this handler. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5921 + + boolean + + jakarta.faces.view.facelets.DelegatingMetaTagHandler.isDisabled +
+ ( + FaceletContext + ) +
+
+ Returns the value of the "disabled" attribute. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5922 + + void + + jakarta.faces.view.facelets.DelegatingMetaTagHandler.setAttributes +
+ ( + FaceletContext + , +
+ Object + ) +
+
+ Invoking/extending this method will cause the results of the created MetaRuleset to + auto-wire state to the passed instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5923 + + void + + jakarta.faces.view.facelets.Facelet.apply +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ The passed UIComponent parent will be populated/restored in accordance with the section + 10.2.1 "Specification of the ViewDeclarationLanguage Implementation for Facelets for Jakarta Faces" + in the Jakarta Faces Specification Document. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5924 + + void + + jakarta.faces.view.facelets.Facelet.apply +
+ ( + FacesContext + , +
+ UIComponent + ) + +
+ throws + IOException +
+
+
+ if unable to load a file necessary to apply this Facelet + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5925 + + void + + jakarta.faces.view.facelets.Facelet.applyMetadata +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ The passed UIComponent parent will be populated/restored in accordance with the section + 10.2.1 "Specification of the ViewDeclarationLanguage Implementation for Facelets for Jakarta Faces" + in the Jakarta Faces Specification Document with only the meta data as per the f:metadata tag. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5926 + + void + + jakarta.faces.view.facelets.Facelet.applyMetadata +
+ ( + FacesContext + , +
+ UIComponent + ) + +
+ throws + IOException +
+
+
+ if unable to load a file necessary to apply this Facelet + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5927 + + Facelet + + jakarta.faces.view.facelets.Facelet.Facelet +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5928 + + FaceletCache + + jakarta.faces.view.facelets.FaceletCache.FaceletCache +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5929 + + Object + + jakarta.faces.view.facelets.FaceletCache.getFacelet +
+ ( + URL + ) +
+
+ Returns a cached Facelet instance. If no instance is available, it will be created + using the Facelet MemberFactory and stored in the cache. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5930 + + Object + + jakarta.faces.view.facelets.FaceletCache.getFacelet +
+ ( + URL + ) + +
+ throws + IOException +
+
+
+ if unable to load a file necessary to respond to service this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5931 + + Object + + jakarta.faces.view.facelets.FaceletCache.getViewMetadataFacelet +
+ ( + URL + ) +
+
+ Returns a cached View Metadata Facelet instance. If no instance is available, it will + be created using the View Metadata Facelet MemberFactory and stored in the cache. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5932 + + Object + + jakarta.faces.view.facelets.FaceletCache.getViewMetadataFacelet +
+ ( + URL + ) + +
+ throws + IOException +
+
+
+ if unable to load a file necessary to respond to service this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5933 + + boolean + + jakarta.faces.view.facelets.FaceletCache.isFaceletCached +
+ ( + URL + ) +
+
+ Determines whether a cached Facelet instance exists for this URL. Returns true if a + cached instance exists, false otherwise + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5934 + + boolean + + jakarta.faces.view.facelets.FaceletCache.isViewMetadataFaceletCached +
+ ( + URL + ) +
+
+ Determines whether a cached View Metadata Facelet instance exists for this URL. Returns + true if a cached instance exists, false otherwise + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5935 + + void + + jakarta.faces.view.facelets.FaceletCache.setCacheFactories +
+ ( + MemberFactory + , +
+ MemberFactory + ) +
+
+ This must be called by the runtime at startup time, before any requests are serviced, + and allows for the FaceletCache implementation to provide the MemberFactory instances that will be + used to create instances of Facelets and View Metadata Facelets. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5936 + + Object + + jakarta.faces.view.facelets.FaceletCache.MemberFactory.newInstance +
+ ( + URL + ) +
+
+ Create a Facelet or View Metadata Facelet (depending on the type of factory this is) + for the argument URL. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5937 + + Object + + jakarta.faces.view.facelets.FaceletCache.MemberFactory.newInstance +
+ ( + URL + ) + +
+ throws + IOException +
+
+
+ if unable to load a file necessary to respond to service this method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5938 + + FaceletCacheFactory + + jakarta.faces.view.facelets.FaceletCacheFactory.FaceletCacheFactory +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:5939 + + FaceletCacheFactory + + jakarta.faces.view.facelets.FaceletCacheFactory.FaceletCacheFactory +
+ ( + FaceletCacheFactory + ) +
+
+ If this factory has been decorated, the implementation doing the decorating should push + the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5940 + + FaceletCache + + jakarta.faces.view.facelets.FaceletCacheFactory.getFaceletCache +
+
+
+ Returns the facility by which the Facelets jakarta.faces.view.ViewDeclarationLanguage + creates and caches instances of Facelets. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5941 + + FaceletCacheFactory + + jakarta.faces.view.facelets.FaceletCacheFactory.getWrapped +
+
+
+ If this factory has been decorated, the implementation doing the decorating may + override this method to provide access to the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5942 + + FaceletContext + + jakarta.faces.view.facelets.FaceletContext.FaceletContext +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5943 + + String + + jakarta.faces.view.facelets.FaceletContext.generateUniqueId +
+ ( + String + ) +
+
+ Generate a unique ID for the passed String + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5944 + + Object + + jakarta.faces.view.facelets.FaceletContext.getAttribute +
+ ( + String + ) +
+
+ Return an attribute set by a previous call to #setAttribute. Support method which is + backed by the current VariableMapper + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5945 + + ExpressionFactory + + jakarta.faces.view.facelets.FaceletContext.getExpressionFactory +
+
+
+ The ExpressionFactory to use within the Facelet this context is executing upon. Must + not be null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5946 + + FacesContext + + jakarta.faces.view.facelets.FaceletContext.getFacesContext +
+
+
+ The current FacesContext bound to this "request". Must not be null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5947 + + void + + jakarta.faces.view.facelets.FaceletContext.includeFacelet +
+ ( + UIComponent + , +
+ String + ) +
+
+ Include another Facelet defined at some path, relative to the executing context, not + the current Facelet (same as include directive in Jakarta Server Pages) + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5948 + + void + + jakarta.faces.view.facelets.FaceletContext.includeFacelet +
+ ( + UIComponent + , +
+ String + ) + +
+ throws + IOException +
+
+
+ if unable to load relativePath + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5949 + + void + + jakarta.faces.view.facelets.FaceletContext.includeFacelet +
+ ( + UIComponent + , +
+ URL + ) +
+
+ Include another Facelet defined at some path, absolute to this ClassLoader/OS + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5950 + + void + + jakarta.faces.view.facelets.FaceletContext.includeFacelet +
+ ( + UIComponent + , +
+ URL + ) + +
+ throws + IOException +
+
+
+ if unable to load relativePath + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5951 + + void + + jakarta.faces.view.facelets.FaceletContext.setAttribute +
+ ( + String + , +
+ Object + ) +
+
+ Support method which is backed by the current VariableMapper. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5952 + + void + + jakarta.faces.view.facelets.FaceletContext.setFunctionMapper +
+ ( + FunctionMapper + ) +
+
+ Set the FunctionMapper to use in EL evaluation/creation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5953 + + void + + jakarta.faces.view.facelets.FaceletContext.setVariableMapper +
+ ( + VariableMapper + ) +
+
+ Set the VariableMapper to use in EL evaluation/creation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5954 + + FaceletException + + jakarta.faces.view.facelets.FaceletException.FaceletException +
+
+
+ Create an empty FaceletException. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5955 + + FaceletException + + jakarta.faces.view.facelets.FaceletException.FaceletException +
+ ( + String + ) +
+
+ Create a FaceletException with argument message as the message. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5956 + + FaceletException + + jakarta.faces.view.facelets.FaceletException.FaceletException +
+ ( + Throwable + ) +
+
+ Wrap argument cause within this FaceletException instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5957 + + FaceletException + + jakarta.faces.view.facelets.FaceletException.FaceletException +
+ ( + String + , +
+ Throwable + ) +
+
+ Wrap argument cause in a FaceletException instance, with a message given by the + argument message. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5958 + + void + + jakarta.faces.view.facelets.FaceletHandler.apply +
+ ( + FaceletContext + , +
+ UIComponent + ) +
+
+ Process changes on a particular UIComponent + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5959 + + void + + jakarta.faces.view.facelets.FaceletHandler.apply +
+ ( + FaceletContext + , +
+ UIComponent + ) + +
+ throws + IOException +
+
+
+ if unable to load relativePath + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5960 + + void + + jakarta.faces.view.facelets.FaceletsAttachedObjectHandler.applyAttachedObject +
+ ( + FacesContext + , +
+ UIComponent + ) +
+
+ Take the necessary actions to apply the attached object represented by the tag for the + concrete subclass of this class to the argument parent. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5961 + + FaceletsAttachedObjectHandler + + jakarta.faces.view.facelets.FaceletsAttachedObjectHandler.FaceletsAttachedObjectHandler +
+ ( + TagConfig + ) +
+
+ Call through to super + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5962 + + String + + jakarta.faces.view.facelets.FaceletsAttachedObjectHandler.getFor +
+
+
+ Return the value of the "for" attribute. This enables the runtime to know to which + inner component this attached object should be retargeted. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5963 + + String + + jakarta.faces.view.facelets.FacetHandler.getFacetName +
+ ( + FaceletContext + ) +
+
+ Returns the resolved literal String value of the facet name after evaluating EL. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5964 + + void + + jakarta.faces.view.facelets.Metadata.applyMetadata +
+ ( + FaceletContext + , +
+ Object + ) +
+
+ Take the action prescribed in the Jakarta Faces Specification for this particular VDL + element attribute. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5965 + + Metadata + + jakarta.faces.view.facelets.Metadata.Metadata +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5966 + + PropertyDescriptor + + jakarta.faces.view.facelets.MetadataTarget.getProperty +
+ ( + String + ) +
+
+ Return a beans PropertyDescriptor for the property with name given by argument name. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5967 + + Class + + jakarta.faces.view.facelets.MetadataTarget.getPropertyType +
+ ( + String + ) +
+
+ Return a Class for the property with name given by argument name. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5968 + + Method + + jakarta.faces.view.facelets.MetadataTarget.getReadMethod +
+ ( + String + ) +
+
+ Return a Method for the getter of the property with name given by argument name. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5969 + + Class + + jakarta.faces.view.facelets.MetadataTarget.getTargetClass +
+
+
+ Return the Class of the metadata target. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5970 + + Method + + jakarta.faces.view.facelets.MetadataTarget.getWriteMethod +
+ ( + String + ) +
+
+ Return a Method for the setter of the property with name given by argument name. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5971 + + boolean + + jakarta.faces.view.facelets.MetadataTarget.isTargetInstanceOf +
+ ( + Class + ) +
+
+ Return true if the target for this metadata element is an instance of the argument + type. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5972 + + MetadataTarget + + jakarta.faces.view.facelets.MetadataTarget.MetadataTarget +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5973 + + Metadata + + jakarta.faces.view.facelets.MetaRule.applyRule +
+ ( + String + , +
+ TagAttribute + , +
+ MetadataTarget + ) +
+
+ Return an abstraction that takes appropriate action given the kind of rule represented + by the argument name, in the context of this particular concrete subclass of MetaRule. The + abstraction must encapsulate the value from the argument attribute. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5974 + + MetaRule + + jakarta.faces.view.facelets.MetaRule.MetaRule +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5975 + + MetaRuleset + + jakarta.faces.view.facelets.MetaRuleset.add +
+ ( + Metadata + ) +
+
+ Add another Metadata to this ruleset, returning this. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5976 + + MetaRuleset + + jakarta.faces.view.facelets.MetaRuleset.addRule +
+ ( + MetaRule + ) +
+
+ Add another MetaRule to this ruleset, returning this. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5977 + + MetaRuleset + + jakarta.faces.view.facelets.MetaRuleset.alias +
+ ( + String + , +
+ String + ) +
+
+ Customize this MetaRuleset by removing the attribute named by argument attribute and + re-adding it under the name given by the argument property, returning this. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5978 + + Metadata + + jakarta.faces.view.facelets.MetaRuleset.finish +
+
+
+ Take actions to apply the rule. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5979 + + MetaRuleset + + jakarta.faces.view.facelets.MetaRuleset.ignore +
+ ( + String + ) +
+
+ Customize this MetaRuleset instance to advise it to ignore the attribute named by the + attribute argument, returning this. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5980 + + MetaRuleset + + jakarta.faces.view.facelets.MetaRuleset.ignoreAll +
+
+
+ Customize this MetaRuleset instance to advise it to ignore all attributes, returning + this. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5981 + + MetaRuleset + + jakarta.faces.view.facelets.MetaRuleset.MetaRuleset +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:5982 + + MetaTagHandler + + jakarta.faces.view.facelets.MetaTagHandler.MetaTagHandler +
+ ( + TagConfig + ) +
+
+ Constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5983 + + TagAttributes + + jakarta.faces.view.facelets.Tag.getAttributes +
+
+
+ Return an object encapsulating the TagAttributes specified on this element in the view. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5984 + + String + + jakarta.faces.view.facelets.Tag.getLocalName +
+
+
+ Return the XML local name of the tag. For example, would be "tag". + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5985 + + Location + + jakarta.faces.view.facelets.Tag.getLocation +
+
+
+ Return the Location of this Tag instance in the Facelet view. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5986 + + String + + jakarta.faces.view.facelets.Tag.getNamespace +
+
+
+ Return the resolved XML Namespace for this tag in the Facelets view. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5987 + + String + + jakarta.faces.view.facelets.Tag.getQName +
+
+
+ Return the XML qualified name for this tag. For example, would be "my:tag". + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5988 + + Tag + + jakarta.faces.view.facelets.Tag.Tag +
+ ( + Location + , +
+ String + , +
+ String + , +
+ String + , +
+ TagAttributes + ) +
+
+ Constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5989 + + Tag + + jakarta.faces.view.facelets.Tag.Tag +
+ ( + Tag + , +
+ TagAttributes + ) +
+
+ Constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5990 + + String + + jakarta.faces.view.facelets.Tag.toString +
+
+
+ Get the string representation. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5991 + + boolean + + jakarta.faces.view.facelets.TagAttribute.getBoolean +
+ ( + FaceletContext + ) +
+
+ If literal,return Boolean#valueOf(java.lang.String) Boolean.valueOf(java.lang.String) + passing our value, otherwise call #getObject(FaceletContext, Class) getObject(FaceletContext, + Class). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5992 + + int + + jakarta.faces.view.facelets.TagAttribute.getInt +
+ ( + FaceletContext + ) +
+
+ If literal, call Integer#parseInt(java.lang.String) Integer.parseInt(String), otherwise + call #getObject(FaceletContext, Class) getObject(FaceletContext, Class). + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5993 + + String + + jakarta.faces.view.facelets.TagAttribute.getLocalName +
+
+
+ Local name of this attribute + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5994 + + Location + + jakarta.faces.view.facelets.TagAttribute.getLocation +
+
+
+ The location of this attribute in the FaceletContext + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5995 + + MethodExpression + + jakarta.faces.view.facelets.TagAttribute.getMethodExpression +
+ ( + FaceletContext + , +
+ Class + , +
+ Class[] + ) +
+
+ Create a MethodExpression, using this attribute's value as the expression String. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5996 + + String + + jakarta.faces.view.facelets.TagAttribute.getNamespace +
+
+
+ The resolved Namespace for this attribute + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5997 + + Object + + jakarta.faces.view.facelets.TagAttribute.getObject +
+ ( + FaceletContext + ) +
+
+ Delegates to getObject with Object.class as a param + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5998 + + Object + + jakarta.faces.view.facelets.TagAttribute.getObject +
+ ( + FaceletContext + , +
+ Class + ) +
+
+ If literal, simply coerce our String literal value using an ExpressionFactory, + otherwise create a ValueExpression and evaluate it. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:5999 + + String + + jakarta.faces.view.facelets.TagAttribute.getQName +
+
+
+ The qualified name for this attribute + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6000 + + Tag + + jakarta.faces.view.facelets.TagAttribute.getTag +
+
+
+ A reference to the Tag for which this class represents the attributes. For + compatibility with previous implementations, an implementation is provided that returns null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6001 + + String + + jakarta.faces.view.facelets.TagAttribute.getValue +
+
+
+ Return the literal value of this attribute + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6002 + + String + + jakarta.faces.view.facelets.TagAttribute.getValue +
+ ( + FaceletContext + ) +
+
+ If literal, then return our value, otherwise delegate to getObject, passing + String.class. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6003 + + ValueExpression + + jakarta.faces.view.facelets.TagAttribute.getValueExpression +
+ ( + FaceletContext + , +
+ Class + ) +
+
+ Create a ValueExpression, using this attribute's literal value and the passed expected + type. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6004 + + boolean + + jakarta.faces.view.facelets.TagAttribute.isLiteral +
+
+
+ If this TagAttribute is literal (not #{..} or ${..}) + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6005 + + void + + jakarta.faces.view.facelets.TagAttribute.setTag +
+ ( + Tag + ) +
+
+ Set a reference to the Tag for which this class represents the attributes. The VDL + runtime must ensure that this method is called before any FaceletHandlers for this element are + instantiated. For compatibility with previous implementations, a no-op implementation is provided. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6006 + + TagAttribute + + jakarta.faces.view.facelets.TagAttribute.TagAttribute +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:6007 + + TagAttributeException + + jakarta.faces.view.facelets.TagAttributeException.TagAttributeException +
+ ( + TagAttribute + ) +
+
+ Constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6008 + + TagAttributeException + + jakarta.faces.view.facelets.TagAttributeException.TagAttributeException +
+ ( + TagAttribute + , +
+ String + ) +
+
+ Constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6009 + + TagAttributeException + + jakarta.faces.view.facelets.TagAttributeException.TagAttributeException +
+ ( + TagAttribute + , +
+ Throwable + ) +
+
+ Constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6010 + + TagAttributeException + + jakarta.faces.view.facelets.TagAttributeException.TagAttributeException +
+ ( + TagAttribute + , +
+ String + , +
+ Throwable + ) +
+
+ Constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6011 + + TagAttributeException + + jakarta.faces.view.facelets.TagAttributeException.TagAttributeException +
+ ( + Tag + , +
+ TagAttribute + ) +
+
+ Constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6012 + + TagAttributeException + + jakarta.faces.view.facelets.TagAttributeException.TagAttributeException +
+ ( + Tag + , +
+ TagAttribute + , +
+ String + ) +
+
+ Constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6013 + + TagAttributeException + + jakarta.faces.view.facelets.TagAttributeException.TagAttributeException +
+ ( + Tag + , +
+ TagAttribute + , +
+ Throwable + ) +
+
+ Constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6014 + + TagAttributeException + + jakarta.faces.view.facelets.TagAttributeException.TagAttributeException +
+ ( + Tag + , +
+ TagAttribute + , +
+ String + , +
+ Throwable + ) +
+
+ Constructor. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6015 + + TagAttribute + + jakarta.faces.view.facelets.TagAttributes.get +
+ ( + String + ) +
+
+ Using no namespace, find the TagAttribute + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6016 + + TagAttribute + + jakarta.faces.view.facelets.TagAttributes.get +
+ ( + String + , +
+ String + ) +
+
+ Find a TagAttribute that matches the passed namespace and local name. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6017 + + TagAttribute[] + + jakarta.faces.view.facelets.TagAttributes.getAll +
+
+
+ Return an array of all TagAttributes in this set + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6018 + + TagAttribute[] + + jakarta.faces.view.facelets.TagAttributes.getAll +
+ ( + String + ) +
+
+ Get all TagAttributes for the passed namespace + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6019 + + String[] + + jakarta.faces.view.facelets.TagAttributes.getNamespaces +
+
+
+ A list of Namespaces found in this set + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6020 + + Tag + + jakarta.faces.view.facelets.TagAttributes.getTag +
+
+
+ A reference to the Tag for which this class represents the attributes. For + compatibility with previous implementations, an implementation is provided that returns null. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6021 + + void + + jakarta.faces.view.facelets.TagAttributes.setTag +
+ ( + Tag + ) +
+
+ Set a reference to the Tag for which this class represents the attributes. The VDL + runtime must ensure that this method is called before any FaceletHandlers for this element are + instantiated. For compatibility with previous implementations, a no-op implementation is provided. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6022 + + TagAttributes + + jakarta.faces.view.facelets.TagAttributes.TagAttributes +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:6023 + + FaceletHandler + + jakarta.faces.view.facelets.TagConfig.getNextHandler +
+
+
+ The next FaceletHandler (child or children) to be applied. This must never be null. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6024 + + Tag + + jakarta.faces.view.facelets.TagConfig.getTag +
+
+
+ Return the Tag representing this handler. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6025 + + String + + jakarta.faces.view.facelets.TagConfig.getTagId +
+
+
+ A document-unique id, follows the convention "_tagId##" + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6026 + + Tag + + jakarta.faces.view.facelets.TagDecorator.decorate +
+ ( + Tag + ) +
+
+ If handled, return a new Tag instance, otherwise return null + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6027 + + TagException + + jakarta.faces.view.facelets.TagException.TagException +
+ ( + Tag + ) +
+
+ Wrap the argument tag so the exception can reference its information. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6028 + + TagException + + jakarta.faces.view.facelets.TagException.TagException +
+ ( + Tag + , +
+ String + ) +
+
+ Wrap the argument tag so the exception can reference its information. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6029 + + TagException + + jakarta.faces.view.facelets.TagException.TagException +
+ ( + Tag + , +
+ Throwable + ) +
+
+ Wrap the argument tag so the exception can reference its information. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6030 + + TagException + + jakarta.faces.view.facelets.TagException.TagException +
+ ( + Tag + , +
+ String + , +
+ Throwable + ) +
+
+ Wrap the argument tag so the exception can reference its information. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6031 + + TagHandler + + jakarta.faces.view.facelets.TagHandler.TagHandler +
+ ( + TagConfig + ) +
+
+ Every TagHandler instance is associated with a Tag. Each Tag instance has a + TagAttributes property, which is simply a collection of TagAttribute instances. Extract and save as + protected instance variables the TagConfig#getTagId, TagConfig#getTag and TagConfig#getNextHandler + returns from the argument TagConfig. This constructor is only called when the Facelets View is + compiled. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6032 + + String + + jakarta.faces.view.facelets.TagHandler.toString +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:6033 + + void + + jakarta.faces.view.facelets.TagHandlerDelegate.apply +
+ ( + FaceletContext + , +
+ UIComponent + ) +
+
+ Called by classes that implement jakarta.faces.view.facelets.FaceletHandler in their + implementation of apply(). If the argument comp is new to the view, for each tag attribute declared + to be in the pass through attribute namespace, set the name and value of the attribute into the pass + through attributes map of the component. See UIComponent#getPassThroughAttributes(boolean) . See the + VDLDocs for the namespace URI of the pass through attribute namespace. Attributes whose value is a + ValueExpression must remain un-evaluated and stored in the map as ValueExpression instances. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6034 + + void + + jakarta.faces.view.facelets.TagHandlerDelegate.apply +
+ ( + FaceletContext + , +
+ UIComponent + ) + +
+ throws + IOException +
+
+
+ if any files necessary to apply this tag handler have any difficulty while loading + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6035 + + MetaRuleset + + jakarta.faces.view.facelets.TagHandlerDelegate.createMetaRuleset +
+ ( + Class + ) +
+
+ Return a MetaRuleset particular to this kind of tag handler. Called from classes that + implement MetaTagHandler. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6036 + + TagHandlerDelegate + + jakarta.faces.view.facelets.TagHandlerDelegate.TagHandlerDelegate +
+
+
+ +
+
+
+ true + + +
+
+
+ true +
+ JSF:JAVADOC:6037 + + TagHandlerDelegate + + jakarta.faces.view.facelets.TagHandlerDelegateFactory.createBehaviorHandlerDelegate +
+ ( + BehaviorHandler + ) +
+
+ Create and return a TagHandlerDelegate instance designed for use with BehaviorHandler. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6038 + + TagHandlerDelegate + + jakarta.faces.view.facelets.TagHandlerDelegateFactory.createComponentHandlerDelegate +
+ ( + ComponentHandler + ) +
+
+ Create and return a TagHandlerDelegate instance designed for use with ComponentHandler. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6039 + + TagHandlerDelegate + + jakarta.faces.view.facelets.TagHandlerDelegateFactory.createConverterHandlerDelegate +
+ ( + ConverterHandler + ) +
+
+ Create and return a TagHandlerDelegate instance designed for use with ConverterHandler. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6040 + + TagHandlerDelegate + + jakarta.faces.view.facelets.TagHandlerDelegateFactory.createValidatorHandlerDelegate +
+ ( + ValidatorHandler + ) +
+
+ Create and return a TagHandlerDelegate instance designed for use with ValidatorHandler. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6041 + + TagHandlerDelegateFactory + + jakarta.faces.view.facelets.TagHandlerDelegateFactory.getWrapped +
+
+
+ If this factory has been decorated, the implementation doing the decorating may + override this method to provide access to the implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6042 + + TagHandlerDelegateFactory + + jakarta.faces.view.facelets.TagHandlerDelegateFactory.TagHandlerDelegateFactory +
+
+
+ +
+
+
+ true + + true + + true +
+ JSF:JAVADOC:6043 + + TagHandlerDelegateFactory + + jakarta.faces.view.facelets.TagHandlerDelegateFactory.TagHandlerDelegateFactory +
+ ( + TagHandlerDelegateFactory + ) +
+
+ If this factory has been decorated, the implementation doing the decorating should push + the implementation being wrapped to this constructor. The #getWrapped() will then return the + implementation being wrapped. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6044 + + String + + jakarta.faces.view.facelets.TextHandler.getText +
+
+
+ Returns the literal String value of the contained text. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6045 + + String + + jakarta.faces.view.facelets.TextHandler.getText +
+ ( + FaceletContext + ) +
+
+ Returns the resolved literal String value of the contained text after evaluating EL. + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6046 + + String + + jakarta.faces.view.facelets.ValidatorConfig.getValidatorId +
+
+
+ Return the validator-id associated with a particular validator in your faces-config + + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6047 + + ValidatorConfig + + jakarta.faces.view.facelets.ValidatorHandler.getValidatorConfig +
+
+
+ Return the TagConfig subclass used to configure this handler instance. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6048 + + String + + jakarta.faces.view.facelets.ValidatorHandler.getValidatorId +
+ ( + FaceletContext + ) +
+
+ Retrieve the id of the validator that is to be created and added to the parent + EditableValueHolder. All subclasses should override this method because it is important for Facelets + to have a unique way of identifying the validators that are added to this EditableValueHolder and + allows exclusions to work properly. An exclusion is a validator declaration that has the attribute + "disabled" which resolves to false, instructing Facelets not to register a default validator with + the same id. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6049 + + ValidatorHandler + + jakarta.faces.view.facelets.ValidatorHandler.ValidatorHandler +
+ ( + ValidatorConfig + ) +
+
+ Construct this instance around the configuration information in argument config + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6050 + + ServletConfig + + jakarta.faces.webapp.FacesServlet.getServletConfig +
+
+
+ Return the ServletConfig instance for this servlet. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6051 + + void + + jakarta.faces.webapp.FacesServlet.init +
+ ( + ServletConfig + ) +
+
+ Acquire the factory instances we will require. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6052 + + void + + jakarta.faces.webapp.FacesServlet.init +
+ ( + ServletConfig + ) + +
+ throws + ServletException +
+
+
+ if, for any reason, the startup of this Faces application failed. This includes errors + in the config file that is parsed before or during the processing of this init() method. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6053 + + void + + jakarta.faces.webapp.FacesServlet.service +
+ ( + ServletRequest + , +
+ ServletResponse + ) +
+
+ Process an incoming request, and create the corresponding response according to the + following specification. If the request and response arguments to this method are not instances of + HttpServletRequest and HttpServletResponse, respectively, the results of invoking this method are + undefined. This method must respond to requests that contain the following strings by invoking the + sendError method on the response argument (cast to HttpServletResponse), passing the code + HttpServletResponse.SC_NOT_FOUND as the argument. /WEB-INF/ /WEB-INF /META-INF/ /META-INF If none of + the cases described above in the specification for this method apply to the servicing of this + request, the following action must be taken to service the request. Acquire a FacesContext instance + for this request. Acquire the ResourceHandler for this request by calling + jakarta.faces.application.Application#getResourceHandler. Call + jakarta.faces.application.ResourceHandler#isResourceRequest. If this returns true call + jakarta.faces.application.ResourceHandler#handleResourceRequest. If this returns false, call + jakarta.faces.lifecycle.Lifecycle#attachWindow followed by jakarta.faces.lifecycle.Lifecycle#execute + followed by jakarta.faces.lifecycle.Lifecycle#render. If a jakarta.faces.FacesException is thrown in + either case, extract the cause from the FacesException. If the cause is null extract the message + from the FacesException, put it inside of a new ServletException instance, and pass the + FacesException instance as the root cause, then rethrow the ServletException instance. If the cause + is an instance of ServletException, rethrow the cause. If the cause is an instance of IOException, + rethrow the cause. Otherwise, create a new ServletException instance, passing the message from the + cause, as the first argument, and the cause itself as the second argument. The implementation must + make it so jakarta.faces.context.FacesContext#release is called within a finally block as late as + possible in the processing for the Jakarta Faces related portion of this request. + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6054 + + void + + jakarta.faces.webapp.FacesServlet.service +
+ ( + ServletRequest + , +
+ ServletResponse + ) + +
+ throws + IOException +
+
+
+ if an input/output error occurs during processing + + true + + +
+
+
+ true +
+ JSF:JAVADOC:6055 + + void + + jakarta.faces.webapp.FacesServlet.service +
+ ( + ServletRequest + , +
+ ServletResponse + ) + +
+ throws + ServletException +
+
+
+ if a Jakarta Servlet error occurs during processing + + true + + +
+
+
+ true +
+ + + \ No newline at end of file diff --git a/install/jsf/docs/assertions/JakartaServerFacesJavadocAssertions.html b/install/jsf/docs/assertions/JakartaServerFacesJavadocAssertions_3.0.html similarity index 100% rename from install/jsf/docs/assertions/JakartaServerFacesJavadocAssertions.html rename to install/jsf/docs/assertions/JakartaServerFacesJavadocAssertions_3.0.html diff --git a/internal/docs/jsf/JSFJavadocAssertions.xml b/internal/docs/jsf/JSFJavadocAssertions_2.3.xml similarity index 100% rename from internal/docs/jsf/JSFJavadocAssertions.xml rename to internal/docs/jsf/JSFJavadocAssertions_2.3.xml diff --git a/internal/docs/jsf/JSFJavadocAssertions_4.0.xml b/internal/docs/jsf/JSFJavadocAssertions_4.0.xml new file mode 100644 index 0000000000..57f9295978 --- /dev/null +++ b/internal/docs/jsf/JSFJavadocAssertions_4.0.xml @@ -0,0 +1,66452 @@ + + + + + 6056 + 2219 + JSF + JSF 2.3 + Java Server Faces + 2.3 + + + + + + 1 + Construct a new exception with no detail message or root cause. + jakarta.faces + FacesException + + + + 2 + Construct a new exception with the specified detail message and no root cause. + jakarta.faces + FacesException + + + java.lang.String + + + + + 3 + Construct a new exception with the specified root cause. The detail message will be set to (cause == null ? null : cause.toString() + jakarta.faces + FacesException + + + java.lang.Throwable + + + + + 4 + Construct a new exception with the specified detail message and root cause. + jakarta.faces + FacesException + + + java.lang.String + java.lang.Throwable + + + + + 5 + Return the cause of this exception, or null if the cause is nonexistent or unknown. + jakarta.faces + FacesException + + + + 7 + if the web application class loader cannot be identified + jakarta.faces + FactoryFinder + + + java.lang.String + + jakarta.faces.FacesException + + + + 12 + if the web application class loader cannot be identified + jakarta.faces + FactoryFinder + + jakarta.faces.FacesException + + + + 15 + + jakarta.faces.application + Application + + + + 33 + Create (if needed) and return an Application instance for this web application. + jakarta.faces.application + ApplicationFactory + + + + 34 + Replace the Application instance that will be returned for this web application. + jakarta.faces.application + ApplicationFactory + + + jakarta.faces.application.Application + + + + + 37 + + jakarta.faces.application + NavigationHandler + + + + 91 + Create a new UICommand instance with default property values. + jakarta.faces.component + UICommand + + + + 207 + if an input/output error occurs while rendering + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + 210 + if an input/output error occurs while rendering + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + 213 + if an input/output error occurs while rendering + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + 234 + Return the Renderer type for this UIComponent (if any). + jakarta.faces.component + UIComponent + + + + 238 + Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. + jakarta.faces.component + UIComponent + + + + 270 + Set the rendered property of this UIComponent. + jakarta.faces.component + UIComponent + + + boolean + + + + + 271 + Set the Renderer type for this UIComponent, or null for components that render themselves. + jakarta.faces.component + UIComponent + + + java.lang.String + + + + + 302 + if an input/output error occurs while rendering + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + 305 + if an input/output error occurs while rendering + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + 308 + if an input/output error occurs while rendering + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + 329 + Return the Renderer type for this UIComponent (if any). + jakarta.faces.component + UIComponentBase + + + + 333 + Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. + jakarta.faces.component + UIComponentBase + + + + 365 + Set the rendered property of this UIComponent. + jakarta.faces.component + UIComponentBase + + + boolean + + + + + 366 + Set the Renderer type for this UIComponent, or null for components that render themselves. + jakarta.faces.component + UIComponentBase + + + java.lang.String + + + + + 376 + Create a new UIForm instance with default property values. + jakarta.faces.component + UIForm + + + + 474 + Create a new UIGraphic instance with default property values. + jakarta.faces.component + UIGraphic + + + + 589 + Create a new UIInput instance with default property values. + jakarta.faces.component + UIInput + + + + 803 + Create a new UIOutput instance with default property values. + jakarta.faces.component + UIOutput + + + + 900 + Create a new UIPanel instance with default property values. + jakarta.faces.component + UIPanel + + + + 1003 + Return the optional parameter name for this parameter. + jakarta.faces.component + UIParameter + + + + 1005 + Set the optional parameter name for this parameter. + jakarta.faces.component + UIParameter + + + java.lang.String + + + + + 1006 + Create a new UIParameter instance with default property values. + jakarta.faces.component + UIParameter + + + + 1111 + Create a new UISelectBoolean instance with default property values. + jakarta.faces.component + UISelectBoolean + + + + 1222 + Return the description for this selection item. + jakarta.faces.component + UISelectItem + + + + 1223 + Return the localized label for this selection item. + jakarta.faces.component + UISelectItem + + + + 1226 + Set the description for this selection item. + jakarta.faces.component + UISelectItem + + + java.lang.String + + + + + 1227 + Set the localized label for this selection item. + jakarta.faces.component + UISelectItem + + + java.lang.String + + + + + 1438 + Create a new UISelectMany instance with default property values. + jakarta.faces.component + UISelectMany + + + + 1562 + Create a new UISelectOne instance with default property values. + jakarta.faces.component + UISelectOne + + + + 1695 + Return the ResponseStream to which components should direct their binary output. Within a given response, components can use either the ResponseStream or the ResponseWriter, but not both. + jakarta.faces.context + FacesContext + + + + 1696 + Return the ResponseWriter to which components should direct their character-based output. Within a given response, components can use either the ResponseStream or the ResponseWriter, but not both. + jakarta.faces.context + FacesContext + + + + 1705 + Set the ResponseStream to which components should direct their binary output. + jakarta.faces.context + FacesContext + + + jakarta.faces.context.ResponseStream + + + + + 1707 + Set the ResponseWriter to which components should direct their character-based output. + jakarta.faces.context + FacesContext + + + jakarta.faces.context.ResponseWriter + + + + + 1749 + + jakarta.faces.context + ResponseStream + + + + 1760 + Write whatever text should end a response. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.context + ResponseWriter + + + + 1761 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + java.io.IOException + + + + 1763 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + + java.lang.String + + java.io.IOException + + + + 1765 + + jakarta.faces.context + ResponseWriter + + + + 1766 + Write whatever text should begin a response. + jakarta.faces.context + ResponseWriter + + + + 1767 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + java.io.IOException + + + + 1776 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + + java.lang.Object + + java.io.IOException + + + + 1787 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + + char[] + int + int + + java.io.IOException + + + + 1811 + Convert the specified model object value, which is associated with the specified UIComponent, into a String that is suitable for being included in the response generated during the Render Response phase of the request processing lifeycle. + jakarta.faces.convert + Converter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + 1814 + Construct a new exception with no detail message or root cause. + jakarta.faces.convert + ConverterException + + + + 1815 + Construct a new exception with the specified detail message and no root cause. + jakarta.faces.convert + ConverterException + + + java.lang.String + + + + + 1816 + Construct a new exception with the specified root cause. The detail message will be set to (cause == null ? null : cause.toString() + jakarta.faces.convert + ConverterException + + + java.lang.Throwable + + + + + 1817 + Construct a new exception with the specified detail message and root cause. + jakarta.faces.convert + ConverterException + + + java.lang.String + java.lang.Throwable + + + + + 1896 + Invoked when the action described by the specified ActionEvent occurs. + jakarta.faces.event + ActionListener + + + jakarta.faces.event.ActionEvent + + + + + 1899 + Construct a new event object from the specified source component. + jakarta.faces.event + FacesEvent + + + jakarta.faces.component.UIComponent + + + + + 1900 + Return the source UIComponent that sent this event. + jakarta.faces.event + FacesEvent + + + + 1902 + Compare this PhaseId instance to the specified one. Returns a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object. + jakarta.faces.event + PhaseId + + + java.lang.Object + + + + + 1903 + Return the ordinal value of this PhaseId instance. + jakarta.faces.event + PhaseId + + + + 1904 + Return a String representation of this PhaseId instance. + jakarta.faces.event + PhaseId + + + + 1913 + if thrown during the execution of the request processing lifecycle + jakarta.faces.lifecycle + Lifecycle + + + jakarta.faces.context.FacesContext + + jakarta.faces.FacesException + + + + 1916 + + jakarta.faces.lifecycle + Lifecycle + + + + 1920 + Register a new Lifecycle instance, associated with the specified lifecycleId, to be supported by this LifecycleFactory. This method may be called at any time, and makes the corresponding Lifecycle instance available throughout the remaining lifetime of this web application. + jakarta.faces.lifecycle + LifecycleFactory + + + java.lang.String + jakarta.faces.lifecycle.Lifecycle + + + + + 1923 + Create (if needed) and return a Lifecycle instance for the specified lifecycle identifier. The set of available lifecycle identifiers is available via the getLifecycleIds() method. Each call to getLifecycle() for the same lifecycleId, from within the same web application, must return the same Lifecycle instance. + jakarta.faces.lifecycle + LifecycleFactory + + + java.lang.String + + + + + 1926 + Return an Iterator over the set of lifecycle identifiers supported by this factory. This set must include the value specified by LifecycleFactory.DEFAULT_LIFECYCLE. + jakarta.faces.lifecycle + LifecycleFactory + + + + 1936 + if an input/output error occurs while rendering + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.io.IOException + + + + 1938 + Render the child components of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property of this component is true. + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + 1939 + if an input/output error occurs while rendering + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.io.IOException + + + + 1941 + Render the ending of the current state of the specified UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + 1942 + if an input/output error occurs while rendering + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.io.IOException + + + + 1960 + + jakarta.faces.render + Renderer + + + + 1980 + + jakarta.faces.render + RenderKit + + + + 2001 + Construct a Validator with no preconfigured limits. + jakarta.faces.validator + DoubleRangeValidator + + + + 2002 + Construct a Validator with the specified preconfigured limit. + jakarta.faces.validator + DoubleRangeValidator + + + double + + + + + 2003 + Construct a Validator with the specified preconfigured limits. + jakarta.faces.validator + DoubleRangeValidator + + + double + double + + + + + 2008 + Set the maximum value to be enforced by this Validator. + jakarta.faces.validator + DoubleRangeValidator + + + double + + + + + 2010 + Set the minimum value to be enforced by this Validator. + jakarta.faces.validator + DoubleRangeValidator + + + double + + + + + 2018 + Construct a Validator with no preconfigured limits. + jakarta.faces.validator + LengthValidator + + + + 2019 + Construct a Validator with the specified preconfigured limit. + jakarta.faces.validator + LengthValidator + + + int + + + + + 2020 + Construct a Validator with the specified preconfigured limits. + jakarta.faces.validator + LengthValidator + + + int + int + + + + + 2021 + Set the maximum length to be enforced by this Validator. + jakarta.faces.validator + LengthValidator + + + int + + + + + 2023 + Set the minimum length to be enforced by this Validator. + jakarta.faces.validator + LengthValidator + + + int + + + + + 2031 + Construct a Validator with no preconfigured limits. + jakarta.faces.validator + LongRangeValidator + + + + 2032 + Construct a Validator with the specified preconfigured limit. + jakarta.faces.validator + LongRangeValidator + + + long + + + + + 2033 + Construct a Validator with the specified preconfigured limits. + jakarta.faces.validator + LongRangeValidator + + + long + long + + + + + 2034 + Set the maximum value to be enforced by this Validator. + jakarta.faces.validator + LongRangeValidator + + + long + + + + + 2036 + Set the minimum value to be enforced by this Validator. + jakarta.faces.validator + LongRangeValidator + + + long + + + + + 2040 + + jakarta.faces.validator + RequiredValidator + + + + 2087 + Release all resources acquired at startup time. + jakarta.faces.webapp + FacesServlet + + + + 2088 + + jakarta.faces.webapp + FacesServlet + + + + 2090 + Return information about this Servlet. + jakarta.faces.webapp + FacesServlet + + + + + + + + 32 + + jakarta.faces.application + ApplicationFactory + + + + + 1712 + + jakarta.faces.context + FacesContextFactory + + + + + 1927 + + jakarta.faces.lifecycle + LifecycleFactory + + + + + 1991 + + jakarta.faces.render + RenderKitFactory + + + + + + + + + + + + + + + + 6__OLD + Create (if necessary) and return a per-web-application instance of the appropriate implementation class for the specified JavaServer Faces factory class, based on the discovery algorithm described in the class description. + jakarta.faces + FactoryFinder + + + java.lang.String + + + + + + 6 + Create (if necessary) and return a per-web-application instance of the appropriate implementation class for the specified Jakarta Faces factory class, based on the discovery algorithm described in the class description. The standard injectionProvider and wrappers in Jakarta Faces all implement the interface FacesWrapper. If the returned Object is an implementation of one of the standard injectionProvider, it must be legal to cast it to an instance of FacesWrapper and call FacesWrapper#getWrapped on the instance. + jakarta.faces + FactoryFinder + + + java.lang.String + + + + + + + 11__OLD + Release any references to factory instances associated with the class loader for the calling web application. This method should be called as apart of web application shutdown in a container where the JavaServer Faces API classes are part of the container itself, rather than being included inside the web application. + jakarta.faces + FactoryFinder + + + + + 11 + Release any references to factory instances associated with the class loader for the calling web application. This method must be called during of web application shutdown. + jakarta.faces + FactoryFinder + + + + + + 16__OLD + Return the ActionListener that will be the default ActionListener to be registered with relevant components during the Reconstitute Component Tree phase of the request processing lifecycle. The default implementation will perform the following functions: The getPhaseId() method of this listener instance must return PhaseId.INVOKE_APPLICATION. If the source component has a non-null action property, return that value. If the source component has a non-null actionRef property, evaluate this value reference to retrieve the corresponding object. If there is no such corresponding object, or if this object does not implement Action, throw an IllegalArgumentException. Call the invoke() method of the returned object, and return the return value from that method call. + jakarta.faces.application + Application + + + + + 16 + Return the default ActionListener to be registered for all jakarta.faces.component.ActionSource components in this application. If not explicitly set, a default implementation must be provided that performs the functions as specified in the section 7.1.1 "ActionListener Property" in the chapter 7 "Application Integration" of the Jakarta Faces Specification Document. Note that the specification for the default ActionListener contiues to call for the use of a deprecated property (action) and class (MethodBinding). Unfortunately, this is necessary because the default ActionListener must continue to work with components that do not implement jakarta.faces.component.ActionSource2, and only implement jakarta.faces.component.ActionSource. + jakarta.faces.application + Application + + + + + + 17__OLD + Return the NavigationHandler instance that will be passed the outcome returned by any invoked Action for this web application. The default implementation must provide the behavior described in the NavigationHandler class description. + jakarta.faces.application + Application + + + + + 17 + Return the NavigationHandler instance that will be passed the outcome returned by any invoked application action for this web application. If not explicitly set, a default implementation must be provided that performs the functions described in the NavigationHandler class description. The NavigationHandler implementation is declared in the application configuration resources by giving the fully qualified class name as the value of the element within the element. The runtime must employ the decorator pattern as for every other pluggable artifact in Jakarta Faces. + jakarta.faces.application + Application + + + + + + 23__OLD + Replace the default ActionListener that will be registered with relevant components during the Reconstitute Component Tree phase of the requset processing lifecycle. This listener must return PhaseId.INVOKE_APPLICATION from its getPhaseId() method. + jakarta.faces.application + Application + + + jakarta.faces.event.ActionListener + + + + + + 23 + Set the default ActionListener to be registered for all jakarta.faces.component.ActionSource components. + jakarta.faces.application + Application + + + jakarta.faces.event.ActionListener + + + + + + + 26__OLD + Set the NavigationHandler instance that will be passed the outcome returned by any invoked Action for this web application. + jakarta.faces.application + Application + + + jakarta.faces.application.NavigationHandler + + + + + + 26 + Set the NavigationHandler instance that will be passed the outcome returned by any invoked application action for this web application. + jakarta.faces.application + Application + + + jakarta.faces.application.NavigationHandler + + + + + + + 74__OLD + Add a new ActionListener to the set of listeners interested in being notified when ActionEvents occur. + jakarta.faces.component + UICommand + + + jakarta.faces.event.ActionListener + + + + + + 74 + + jakarta.faces.component + UICommand + + + jakarta.faces.event.ActionListener + + + + + + + 86__OLD + Remove an existing ActionListener (if any) from the set of listeners interested in being notified when ActionEvents occur. + jakarta.faces.component + UICommand + + + jakarta.faces.event.ActionListener + + + + + + 86 + + jakarta.faces.component + UICommand + + + jakarta.faces.event.ActionListener + + + + + + + 203__OLD + Decode the current state of this UIComponent from the request contained in the specified FacesContext, and attempt to convert this state information into an object of the required type for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one. If conversion is successful: Save the new local value of this component by calling setValue() and passing the new value. Set the valid property of this component to true. If conversion is not successful: Save state information in such a way that encoding can reproduce the previous input (even though it was syntactically or semantically incorrect) Add an appropriate conversion failure error message by calling context.addMessage(). Set the valid property of this comonent to false. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + 203 + Decode any new state of this UIComponent from the request contained in the specified FacesContext, and store this state as needed. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling queueEvent(). + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + + 206__OLD + Render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. If the conversion attempted in a previous call to decode() for this component failed, the state information saved during execution of decode() should be utilized to reproduce the incorrect input. If the conversion was successful, or if there was no previous call to decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the value as appropriate. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + 206 + If our rendered property is true, render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. Call #pushComponentToEL(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent). Call jakarta.faces.application.Application#publishEvent, passing jakarta.faces.event.PreRenderComponentEvent.class as the first argument and the component instance to be rendered as the second argument. If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer#encodeBegin(FacesContext, UIComponent). If our rendered property is false, call #pushComponentToEL(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent) and return immediately. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + + 209__OLD + Render the child UIComponents of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property is true. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + 209 + If our rendered property is true, render the child UIComponents of this UIComponent. This method will only be called if the rendersChildren property is true. If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer#encodeChildren(FacesContext, UIComponent). If no Renderer is associated with this UIComponent, iterate over each of the children of this component and call #encodeAll(jakarta.faces.context.FacesContext). + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + + 212__OLD + Render the ending of the current state of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + 212 + If our rendered property is true, render the ending of the current state of this UIComponent. If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer#encodeEnd(FacesContext, UIComponent). Call UIComponent#popComponentFromEL. before returning regardless of the value of the rendered property. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + + 215__OLD + Find the UIComponent named by the specified expression, if any is found. This is done by locating the closest parent UIComponent that is a NamingContainer, and calling its findComponentInNamespace() method. The specified expr may contain either a component identifier, or a set of component identifiers separated by SEPARATOR_CHAR characters. + jakarta.faces.component + UIComponent + + + java.lang.String + + + + + + 215 + Search for and return the UIComponent with an id that matches the specified search expression (if any), according to the algorithm described below. WARNING: The found UIComponent instance, if any, is returned without regard for its tree traversal context. Retrieving an Jakarta Expression Language-bound attribute from the component is not safe. Jakarta Expression Language expressions can contain implicit objects, such as #{component}, which assume they are being evaluated within the scope of a tree traversal context. Evaluating expressions with these kinds of implicit objects outside of a tree traversal context produces undefined results. See #invokeOnComponent for a method that does correctly account for the tree traversal context when operating on the found UIComponent instance. #invokeOnComponent is also useful to find components given a simple clientId. Component identifiers are required to be unique within the scope of the closest ancestor NamingContainer that encloses this component (which might be this component itself). If there are no NamingContainer components in the ancestry of this component, the root component in the tree is treated as if it were a NamingContainer, whether or not its class actually implements the NamingContainer interface. A search expression consists of either an identifier (which is matched exactly against the id property of a UIComponent, or a series of such identifiers linked by the UINamingContainer#getSeparatorChar character value. The search algorithm should operates as follows, though alternate alogrithms may be used as long as the end result is the same: Identify the UIComponent that will be the base for searching, by stopping as soon as one of the following conditions is met: If the search expression begins with the the separator character (called an "absolute" search expression), the base will be the root UIComponent of the component tree. The leading separator character will be stripped off, and the remainder of the search expression will be treated as a "relative" search expression as described below. Otherwise, if this UIComponent is a NamingContainer it will serve as the basis. Otherwise, search up the parents of this component. If a NamingContainer is encountered, it will be the base. Otherwise (if no NamingContainer is encountered) the root UIComponent will be the base. The search expression (possibly modified in the previous step) is now a "relative" search expression that will be used to locate the component (if any) that has an id that matches, within the scope of the base component. The match is performed as follows: If the search expression is a simple identifier, this value is compared to the id property, and then recursively through the facets and children of the base UIComponent (except that if a descendant NamingContainer is found, its own facets and children are not searched). If the search expression includes more than one identifier separated by the separator character, the first identifier is used to locate a NamingContainer by the rules in the previous bullet point. Then, the findComponent() method of this NamingContainer will be called, passing the remainder of the search expression. + jakarta.faces.component + UIComponent + + + java.lang.String + + + + + + + 222__OLD + Return the number of UIComponents on the child list for this component. + jakarta.faces.component + UIComponent + + + + + 222 + Return the number of child UIComponents that are associated with this UIComponent. If there are no children, this method must return 0. The method must not cause the creation of a child component list. + jakarta.faces.component + UIComponent + + + + + + 224__OLD + Return a client-side identifier for this component, generating one if necessary. Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + 224 + Return a client-side identifier for this component, generating one if necessary. The associated Renderer, if any, will be asked to convert the clientId to a form suitable for transmission to the client. The return from this method must be the same value throughout the lifetime of the instance, unless the id property of the component is changed, or the component is placed in a NamingContainer whose client ID changes (for example, UIData). However, even in these cases, consecutive calls to this method must always return the same value. The implementation must follow these steps in determining the clientId: Find the closest ancestor to this component in the view hierarchy that implements NamingContainer. Call getContainerClientId() on it and save the result as the parentId local variable. Call #getId on this component and save the result as the myId local variable. If myId is null, call context.getViewRoot().createUniqueId() and assign the result to myId. If parentId is non-null, let myId equal parentId + UINamingContainer#getSeparatorChar + myId. Call Renderer#convertClientId, passing myId, and return the result. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + + 229__OLD + Return the facet UIComponent associated with the specified name, if any. Otherwise, return null. + jakarta.faces.component + UIComponent + + + java.lang.String + + + + + + 229 + Convenience method to return the named facet, if it exists, or null otherwise. If the requested facet does not exist, the facets Map must not be created. + jakarta.faces.component + UIComponent + + + java.lang.String + + + + + + + 232__OLD + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. + jakarta.faces.component + UIComponent + + + + + 232 + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. The returned Iterator must not support the remove() operation. + jakarta.faces.component + UIComponent + + + + + + 233__OLD + Return the parent UIComponent of this UIComponent, if any. + jakarta.faces.component + UIComponent + + + + + 233 + Return the parent UIComponent of this UIComponent, if any. A component must allow child components to be added to and removed from the list of children of this component, even though the child component returns null from getParent( ). + jakarta.faces.component + UIComponent + + + + + + 235__OLD + Return a flag indicating whether this component is responsible for rendering its child components. + jakarta.faces.component + UIComponent + + + + + 235 + Return a flag indicating whether this component is responsible for rendering its child components. The default implementation in UIComponentBase#getRendersChildren tries to find the renderer for this component. If it does, it calls Renderer#getRendersChildren and returns the result. If it doesn't, it returns false. As of version 1.2 of the Jakarta Faces Specification, component authors are encouraged to return true from this method and rely on UIComponentBase#encodeChildren. + jakarta.faces.component + UIComponent + + + + + + 240__OLD + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + 240 + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. If the rendered property of this UIComponent is false, skip further processing. Call #pushComponentToEL. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. Call #popComponentFromEL from inside of a finally block, just before returning. If a RuntimeException is thrown during decode processing, call FacesContext#renderResponse and re-throw the exception. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + + 246__OLD + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the updateModel() method of this component. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + 246 + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. If the rendered property of this UIComponent is false, skip further processing. Call #pushComponentToEL. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). After returning from the processUpdates() method on a child or facet, call UIComponent#popComponentFromEL + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + + 248__OLD + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property of this component is currently true: Call the validate() method of each Validator registered for this UIComponent. Call the validate() method of this component. Set the valid property of this component to the result returned from the validate() method. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + 248 + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. If the rendered property of this UIComponent is false, skip further processing. Call #pushComponentToEL. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). After returning from calling getFacetsAndChildren() call UIComponent#popComponentFromEL. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + + 269__OLD + Set the parent UIComponent of this UIComponent. + jakarta.faces.component + UIComponent + + + jakarta.faces.component.UIComponent + + + + + + 269 + Set the parent UIComponent of this UIComponent. If parent.isInView() returns true, calling this method will first cause a jakarta.faces.event.PreRemoveFromViewEvent to be published, for this node, and then the children of this node. Then, once the re-parenting has occurred, a jakarta.faces.event.PostAddToViewEvent will be published as well, first for this node, and then for the node's children, but only if any of the following conditions are true. jakarta.faces.context.FacesContext#getCurrentPhaseId returns jakarta.faces.event.PhaseId#RESTORE_VIEW and partial state saving is enabled. jakarta.faces.context.FacesContext#isPostback returns false and jakarta.faces.context.FacesContext#getCurrentPhaseId returns something other than jakarta.faces.event.PhaseId#RESTORE_VIEW This method must never be called by developers; a UIComponent's internal implementation will call it as components are added to or removed from a parent's child List or facet Map. + jakarta.faces.component + UIComponent + + + jakarta.faces.component.UIComponent + + + + + + + 298__OLD + Decode the current state of this UIComponent from the request contained in the specified FacesContext, and attempt to convert this state information into an object of the required type for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one. If conversion is successful: Save the new local value of this component by calling setValue() and passing the new value. Set the valid property of this component to true. If conversion is not successful: Save state information in such a way that encoding can reproduce the previous input (even though it was syntactically or semantically incorrect) Add an appropriate conversion failure error message by calling context.addMessage(). Set the valid property of this comonent to false. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + 298 + Decode any new state of this UIComponent from the request contained in the specified FacesContext, and store this state as needed. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling queueEvent(). + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + + 301__OLD + Render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. If the conversion attempted in a previous call to decode() for this component failed, the state information saved during execution of decode() should be utilized to reproduce the incorrect input. If the conversion was successful, or if there was no previous call to decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the value as appropriate. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + 301 + If our rendered property is true, render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. Call #pushComponentToEL(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent). Call jakarta.faces.application.Application#publishEvent, passing jakarta.faces.event.PreRenderComponentEvent.class as the first argument and the component instance to be rendered as the second argument. If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer#encodeBegin(FacesContext, UIComponent). If our rendered property is false, call #pushComponentToEL(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent) and return immediately. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + + 304__OLD + Render the child UIComponents of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property is true. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + 304 + If our rendered property is true, render the child UIComponents of this UIComponent. This method will only be called if the rendersChildren property is true. If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer#encodeChildren(FacesContext, UIComponent). If no Renderer is associated with this UIComponent, iterate over each of the children of this component and call #encodeAll(jakarta.faces.context.FacesContext). + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + + 307__OLD + Render the ending of the current state of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + 307 + If our rendered property is true, render the ending of the current state of this UIComponent. If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer#encodeEnd(FacesContext, UIComponent). Call UIComponent#popComponentFromEL. before returning regardless of the value of the rendered property. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + + 310__OLD + Find the UIComponent named by the specified expression, if any is found. This is done by locating the closest parent UIComponent that is a NamingContainer, and calling its findComponentInNamespace() method. The specified expr may contain either a component identifier, or a set of component identifiers separated by SEPARATOR_CHAR characters. + jakarta.faces.component + UIComponentBase + + + java.lang.String + + + + + + 310 + Search for and return the UIComponent with an id that matches the specified search expression (if any), according to the algorithm described below. WARNING: The found UIComponent instance, if any, is returned without regard for its tree traversal context. Retrieving an Jakarta Expression Language-bound attribute from the component is not safe. Jakarta Expression Language expressions can contain implicit objects, such as #{component}, which assume they are being evaluated within the scope of a tree traversal context. Evaluating expressions with these kinds of implicit objects outside of a tree traversal context produces undefined results. See #invokeOnComponent for a method that does correctly account for the tree traversal context when operating on the found UIComponent instance. #invokeOnComponent is also useful to find components given a simple clientId. Component identifiers are required to be unique within the scope of the closest ancestor NamingContainer that encloses this component (which might be this component itself). If there are no NamingContainer components in the ancestry of this component, the root component in the tree is treated as if it were a NamingContainer, whether or not its class actually implements the NamingContainer interface. A search expression consists of either an identifier (which is matched exactly against the id property of a UIComponent, or a series of such identifiers linked by the UINamingContainer#getSeparatorChar character value. The search algorithm should operates as follows, though alternate alogrithms may be used as long as the end result is the same: Identify the UIComponent that will be the base for searching, by stopping as soon as one of the following conditions is met: If the search expression begins with the the separator character (called an "absolute" search expression), the base will be the root UIComponent of the component tree. The leading separator character will be stripped off, and the remainder of the search expression will be treated as a "relative" search expression as described below. Otherwise, if this UIComponent is a NamingContainer it will serve as the basis. Otherwise, search up the parents of this component. If a NamingContainer is encountered, it will be the base. Otherwise (if no NamingContainer is encountered) the root UIComponent will be the base. The search expression (possibly modified in the previous step) is now a "relative" search expression that will be used to locate the component (if any) that has an id that matches, within the scope of the base component. The match is performed as follows: If the search expression is a simple identifier, this value is compared to the id property, and then recursively through the facets and children of the base UIComponent (except that if a descendant NamingContainer is found, its own facets and children are not searched). If the search expression includes more than one identifier separated by the separator character, the first identifier is used to locate a NamingContainer by the rules in the previous bullet point. Then, the findComponent() method of this NamingContainer will be called, passing the remainder of the search expression. + jakarta.faces.component + UIComponentBase + + + java.lang.String + + + + + + + 317__OLD + Return the number of UIComponents on the child list for this component. + jakarta.faces.component + UIComponentBase + + + + + 317 + Return the number of child UIComponents that are associated with this UIComponent. If there are no children, this method must return 0. The method must not cause the creation of a child component list. + jakarta.faces.component + UIComponentBase + + + + + + 319__OLD + Return a client-side identifier for this component, generating one if necessary. Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + 319 + Return a client-side identifier for this component, generating one if necessary. The associated Renderer, if any, will be asked to convert the clientId to a form suitable for transmission to the client. The return from this method must be the same value throughout the lifetime of the instance, unless the id property of the component is changed, or the component is placed in a NamingContainer whose client ID changes (for example, UIData). However, even in these cases, consecutive calls to this method must always return the same value. The implementation must follow these steps in determining the clientId: Find the closest ancestor to this component in the view hierarchy that implements NamingContainer. Call getContainerClientId() on it and save the result as the parentId local variable. Call #getId on this component and save the result as the myId local variable. If myId is null, call context.getViewRoot().createUniqueId() and assign the result to myId. If parentId is non-null, let myId equal parentId + UINamingContainer#getSeparatorChar + myId. Call Renderer#convertClientId, passing myId, and return the result. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + + 324__OLD + Return the facet UIComponent associated with the specified name, if any. Otherwise, return null. + jakarta.faces.component + UIComponentBase + + + java.lang.String + + + + + + 324 + Convenience method to return the named facet, if it exists, or null otherwise. If the requested facet does not exist, the facets Map must not be created. + jakarta.faces.component + UIComponentBase + + + java.lang.String + + + + + + + 327__OLD + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. + jakarta.faces.component + UIComponentBase + + + + + 327 + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. The returned Iterator must not support the remove() operation. + jakarta.faces.component + UIComponentBase + + + + + + 328__OLD + Return the parent UIComponent of this UIComponent, if any. + jakarta.faces.component + UIComponentBase + + + + + 328 + Return the parent UIComponent of this UIComponent, if any. A component must allow child components to be added to and removed from the list of children of this component, even though the child component returns null from getParent( ). + jakarta.faces.component + UIComponentBase + + + + + + 330__OLD + Return a flag indicating whether this component is responsible for rendering its child components. + jakarta.faces.component + UIComponentBase + + + + + 330 + Return a flag indicating whether this component is responsible for rendering its child components. The default implementation in UIComponentBase#getRendersChildren tries to find the renderer for this component. If it does, it calls Renderer#getRendersChildren and returns the result. If it doesn't, it returns false. As of version 1.2 of the Jakarta Faces Specification, component authors are encouraged to return true from this method and rely on UIComponentBase#encodeChildren. + jakarta.faces.component + UIComponentBase + + + + + + 335__OLD + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + 335 + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. If the rendered property of this UIComponent is false, skip further processing. Call #pushComponentToEL. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. Call #popComponentFromEL from inside of a finally block, just before returning. If a RuntimeException is thrown during decode processing, call FacesContext#renderResponse and re-throw the exception. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + + 341__OLD + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the updateModel() method of this component. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + 341 + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. If the rendered property of this UIComponent is false, skip further processing. Call #pushComponentToEL. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). After returning from the processUpdates() method on a child or facet, call UIComponent#popComponentFromEL + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + + 343__OLD + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property of this component is currently true: Call the validate() method of each Validator registered for this UIComponent. Call the validate() method of this component. Set the valid property of this component to the result returned from the validate() method. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + 343 + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. If the rendered property of this UIComponent is false, skip further processing. Call #pushComponentToEL. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). After returning from calling getFacetsAndChildren() call UIComponent#popComponentFromEL. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + + 364__OLD + Set the parent UIComponent of this UIComponent. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.component.UIComponent + + + + + + 364 + Set the parent UIComponent of this UIComponent. If parent.isInView() returns true, calling this method will first cause a jakarta.faces.event.PreRemoveFromViewEvent to be published, for this node, and then the children of this node. Then, once the re-parenting has occurred, a jakarta.faces.event.PostAddToViewEvent will be published as well, first for this node, and then for the node's children, but only if any of the following conditions are true. jakarta.faces.context.FacesContext#getCurrentPhaseId returns jakarta.faces.event.PhaseId#RESTORE_VIEW and partial state saving is enabled. jakarta.faces.context.FacesContext#isPostback returns false and jakarta.faces.context.FacesContext#getCurrentPhaseId returns something other than jakarta.faces.event.PhaseId#RESTORE_VIEW This method must never be called by developers; a UIComponent's internal implementation will call it as components are added to or removed from a parent's child List or facet Map. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.component.UIComponent + + + + + + + 368__OLD + + jakarta.faces.component + UIComponentBase + + + + + 368 + Default constructor, populates the descriptor map. + jakarta.faces.component + UIComponentBase + + + + + + 590__OLD + Perform the following algorithm to update the model data associated with this UIInput, if any, as appropriate. If the valid property of this component is false, take no further action. If the valueRef property of this component is null, take no further action. Retrieve the Application instance for this web application from ApplicationFactory. Ask it for a ValueBinding for the valueRef expression. Use the setValue() method of the ValueBinding to update the value that the value reference expression points at. If the setValue() method returns successfully: Clear the local value of this UIInput. Set the valid property of this UIInput to true. If the setValue() method call fails: Enqueue error messages by calling addMessage() on the specified FacesContext instance. Set the valid property of this UIInput to false. + jakarta.faces.component + UIInput + + + jakarta.faces.context.FacesContext + + + + + + 590 + Perform the following algorithm to update the model data associated with this UIInput, if any, as appropriate. If the valid property of this component is false, take no further action. If the localValueSet property of this component is false, take no further action. If no ValueExpression for value exists, take no further action. Call setValue() method of the ValueExpression to update the value that the ValueExpression points at. If the setValue() method returns successfully: Clear the local value of this UIInput. Set the localValueSet property of this UIInput to false. If the setValue() method throws an Exception: Enqueue an error message. Create a FacesMessage with the id #UPDATE_MESSAGE_ID. Create a UpdateModelException, passing the FacesMessage and the caught exception to the constructor. Create an ExceptionQueuedEventContext, passing the FacesContext, the UpdateModelException, this component instance, and PhaseId#UPDATE_MODEL_VALUES to its constructor. Call FacesContext#getExceptionHandler and then call ExceptionHandler#processEvent, passing the ExceptionQueuedEventContext. Set the valid property of this UIInput to false. The exception must not be re-thrown. This enables tree traversal to continue for this lifecycle phase, as in all the other lifecycle phases. + jakarta.faces.component + UIInput + + + jakarta.faces.context.FacesContext + + + + + + + 593__OLD + Perform validations and, if validation is successful, and the local value is different from the previous value, queue a ValueChangedEvent to be processed later. + jakarta.faces.component + UIInput + + + jakarta.faces.context.FacesContext + + + + + + 593 + Perform the following algorithm to validate the local value of this UIInput. Retrieve the submitted value with #getSubmittedValue. If this returns null, and the value of the #ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE context-param is true (ignoring case), examine the value of the "required" property. If the value of "required" is true, continue as below. If the value of "required" is false or the required attribute is not set, exit without further processing. If the context-param is not set, or is set to false (ignoring case), exit without further processing. (This indicates that no value was submitted for this component.) If the jakarta.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL context parameter value is true (ignoring case), and getSubmittedValue() returns a zero-length String call #setSubmittedValue, passing null as the argument and continue processing using null as the current submitted value. Convert the submitted value into a "local value" of the appropriate data type by calling #getConvertedValue. If conversion fails: Enqueue an appropriate error message by calling the addMessage() method on the FacesContext. Set the valid property on this component to false Validate the property by calling #validateValue. If the valid property of this component is still true, retrieve the previous value of the component (with getValue()), store the new local value using setValue(), and reset the submitted value to null with a call to #setSubmittedValue passing null as the argument. If the local value is different from the previous value of this component, as determined by a call to #compareValues, fire a ValueChangeEvent to be broadcast to all interested listeners. Application components implementing UIInput that wish to perform validation with logic embedded in the component should perform their own correctness checks, and then call the super.validate() method to perform the standard processing described above. + jakarta.faces.component + UIInput + + + jakarta.faces.context.FacesContext + + + + + + + 700__OLD + + jakarta.faces.component + UINamingContainer + + + + + 700 + Create a new UINamingContainer instance with default property values. + jakarta.faces.component + UINamingContainer + + + + + + 799__OLD + Return the local value of this UIInput component. + jakarta.faces.component + UIOutput + + + + + 799 + Return the value property. + jakarta.faces.component + UIOutput + + + + + + 801__OLD + Set the local value of this UIInput component. + jakarta.faces.component + UIOutput + + + java.lang.Object + + + + + + 801 + Set the value of this UIComponent (if any). + jakarta.faces.component + UIOutput + + + java.lang.Object + + + + + + + 1109__OLD + Return the local value of the selected state of this component. + jakarta.faces.component + UISelectBoolean + + + + + 1109 + Return the local value of the selected state of this component. This method is a typesafe alias for getValue(). + jakarta.faces.component + UISelectBoolean + + + + + + 1110__OLD + Set the local value of the selected state of this component. + jakarta.faces.component + UISelectBoolean + + + boolean + + + + + + 1110 + Set the local value of the selected state of this component. This method is a typesafe alias for setValue(). + jakarta.faces.component + UISelectBoolean + + + boolean + + + + + + + 1229__OLD + + jakarta.faces.component + UISelectItem + + + + + 1229 + Create a new UISelectItem instance with default property values. + jakarta.faces.component + UISelectItem + + + + + + 1333__OLD + + jakarta.faces.component + UISelectItems + + + + + 1333 + Create a new UISelectItems instance with default property values. + jakarta.faces.component + UISelectItems + + + + + + 1436__OLD + Return the currently selected items, or null if there are no currently selected items. + jakarta.faces.component + UISelectMany + + + + + 1436 + Return the currently selected values, or null if there are no currently selected values. This is a typesafe alias for getValue(). + jakarta.faces.component + UISelectMany + + + + + + 1437__OLD + Set the currently selected items, or null to indicate that there are no currently selected items. + jakarta.faces.component + UISelectMany + + + java.lang.Object[] + + + + + + 1437 + Set the currently selected values, or null to indicate that there are no currently selected values. This is a typesafe alias for setValue(). + jakarta.faces.component + UISelectMany + + + java.lang.Object[] + + + + + + + 1687__OLD + + jakarta.faces.context + FacesContext + + + + + 1687 + Default constructor. This looks at the callstack to see if we're created from a factory. + jakarta.faces.context + FacesContext + + + + + + 1688__OLD + Return the FacesContext instance for the request that is being processed by the current thread. + jakarta.faces.context + FacesContext + + + + + 1688 + Return the FacesContext instance for the request that is being processed by the current thread. If called during application initialization or shutdown, any method documented as "valid to call this method during application startup or shutdown" must be supported during application startup or shutdown time. The result of calling a method during application startup or shutdown time that does not have this designation is undefined. + jakarta.faces.context + FacesContext + + + + + + 1693__OLD + Return an Iterator over the Messages that have been queued, whether or not they are associated with any specific UIComponent. If no such messages have been queued, return an empty Iterator. + jakarta.faces.context + FacesContext + + + + + 1693 + Return an Iterator over the jakarta.faces.application.FacesMessages that have been queued, whether or not they are associated with any specific client identifier. If no such messages have been queued, return an empty Iterator. The elements of the Iterator must be returned in the order in which they were added with calls to #addMessage. + jakarta.faces.context + FacesContext + + + + + + 1701__OLD + Release any resources associated with this FacesContext instance. Faces implementations may choose to pool instances in the associated FacesContextFactory to avoid repeated object creation and garbage collection. + jakarta.faces.context + FacesContext + + + + + 1701 + Release any resources associated with this FacesContext instance. Faces implementations may choose to pool instances in the associated FacesContextFactory to avoid repeated object creation and garbage collection. After release() is called on a FacesContext instance (until the FacesContext instance has been recycled by the implementation for re-use), calling any other methods will cause an IllegalStateException to be thrown. If a call was made to #getAttributes during the processing for this request, the implementation must call clear() on the Map returned from getAttributes(), and then de-allocate the data-structure behind that Map. The implementation must call #setCurrentInstance passing null to remove the association between this thread and this dead FacesContext instance. + jakarta.faces.context + FacesContext + + + + + + 1702__OLD + Signal the JavaSerer faces implementation that, as soon as the current phase of the request processing lifecycle has been completed, control should be passed to the Render Response phase, bypassing any phases that have not been executed yet. + jakarta.faces.context + FacesContext + + + + + 1702 + Signal the Jakarta Faces implementation that, as soon as the current phase of the request processing lifecycle has been completed, control should be passed to the Render Response phase, bypassing any phases that have not been executed yet. + jakarta.faces.context + FacesContext + + + + + + 1703__OLD + Signal the JavaServer Faces implementation that the HTTP response for this request has already been generated (such as an HTTP redirect), and that the request processing lifecycle should be terminated as soon as the current phase is completed. + jakarta.faces.context + FacesContext + + + + + 1703 + Signal the Jakarta Faces implementation that the HTTP response for this request has already been generated (such as an HTTP redirect), and that the request processing lifecycle should be terminated as soon as the current phase is completed. + jakarta.faces.context + FacesContext + + + + + + 1762__OLD + Write the end of an element, after closing any open element created by a call to startElement(). + jakarta.faces.context + ResponseWriter + + + java.lang.String + + + + + + 1762 + Write the end of an element, after closing any open element created by a call to startElement(). Elements must be closed in the inverse order from which they were opened; it is an error to do otherwise. If the argument component's pass through attributes includes an attribute of the name given by the value of the symbolic constant jakarta.faces.render.Renderer#PASSTHROUGH_RENDERER_LOCALNAME_KEY, use that as the element name, instead of the value passed as the first parameter to this method. + jakarta.faces.context + ResponseWriter + + + java.lang.String + + + + + + + 1775__OLD + Write a comment containing the specified text, after converting that text to a String if necessary. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.context + ResponseWriter + + + java.lang.Object + + + + + + 1775 + Write a comment containing the specified text, after converting that text to a String (if necessary), and after performing any escaping appropriate for the markup language being rendered. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.context + ResponseWriter + + + java.lang.Object + + + + + + + 1786__OLD + Write text from a character array, after escaping it properly for this method. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.context + ResponseWriter + + + char[] + int + int + + + + + + 1786 + Write text from a character array, after any performing any escaping appropriate for the markup language being rendered. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.context + ResponseWriter + + + char[] + int + int + + + + + + + 1808__OLD + Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Apply Request Values phase of the request processing lifecycle. + jakarta.faces.convert + Converter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + 1808 + Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle. + jakarta.faces.convert + Converter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + + 1891__OLD + + jakarta.faces.event + AbortProcessingException + + + + + 1891 + Construct a new exception with no detail message or root cause. + jakarta.faces.event + AbortProcessingException + + + + + + 1897__OLD + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.event + ActionListener + + + jakarta.faces.event.ActionEvent + + jakarta.faces.event.AbortProcessingException + + + + + 1897 + Signal the Jakarta Faces implementation that no further processing on the current event should be performed + jakarta.faces.event + ActionListener + + + jakarta.faces.event.ActionEvent + + jakarta.faces.event.AbortProcessingException + + + + + + 1912__OLD + Execute all of the phases of the request processing lifecycle, as described in the JavaServer Faces Specification, in the specified order. The processing flow can be affected (by the application, by components, or by event listeners) by calls to the renderResponse() or responseComplete() methods of the FacesContext instance associated with the current request. + jakarta.faces.lifecycle + Lifecycle + + + jakarta.faces.context.FacesContext + + + + + + 1912 + Execute all of the phases of the request processing lifecycle, up to but not including the Render Response phase, as described in section 2 "Request Processing Lifecycle" of the Jakarta Faces Specification Document, in the specified order. The processing flow can be affected (by the application, by components, or by event listeners) by calls to the renderResponse() or responseComplete() methods of the FacesContext instance associated with the current request. + jakarta.faces.lifecycle + Lifecycle + + + jakarta.faces.context.FacesContext + + + + + + + 1932__OLD + Decode the current state of the specified UIComponent from the request contained in the specified FacesContext, and attempt to convert this state information into an object of the type required for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one). If conversion is successful: Save the new local value of this component by calling setValue() and passing the new value. Set the value property of this component to true. If conversion is not successful: Save the state information (inside the component) in such a way that encoding can reproduce the previous input (even though it was syntactically or semantically incorrect). Add an appropriate conversion failure error message by calling addMessage() on the specified FacesContext. Set the valid property of this component to false. During decoding, events may be enqueued for later processing (by event listeners that have registered an interest), by calling addFacesEvent() on the associated FacesContext. + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + 1932 + Decode any new state of the specified UIComponent from the request contained in the specified FacesContext, and store that state on the UIComponent. During decoding, events may be enqueued for later processing (by event listeners that have registered an interest), by calling queueEvent() on the associated UIComponent. + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + + 1935__OLD + Render the beginning specified UIComponent to the output stream or writer associated with the response we are creating. If the conversion attempted in a previous call to decode for this component failed, the state information saved during execution of decode() should be utilized to reproduce the incorrect input. If the conversion was successful, or if there was no previous call to decode(), the value to be displayed should be acquired by calling component.currentValue(), and rendering the value as appropriate. + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + 1935 + Render the beginning specified UIComponent to the output stream or writer associated with the response we are creating. If the conversion attempted in a previous call to getConvertedValue() for this component failed, the state information saved during execution of decode() should be used to reproduce the incorrect input. + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + + 1976__OLD + Return an Iterator of the renderer types of all Renderer instances registered with this RenderKit that support components of the specified component type. If no Renderers support this component type, an empty Iterator is returned. + jakarta.faces.render + RenderKit + + + java.lang.String + + + + + + 1976 + Return an Iterator over the renderer-type entries for the given component-family. If the specified componentFamily is not known to this RenderKit implementation, return an empty Iterator The default implementation of this method returns an empty Iterator + jakarta.faces.render + RenderKit + + + java.lang.String + + + + + + + 1981__OLD + Register a new RenderKit instance, associated with the specified renderKitId, to be supported by this RenderKitFactory. This method may be called at any time, and makes the corresponding RenderKit instance available throughout the remaining lifetime of this web application. + jakarta.faces.render + RenderKitFactory + + + java.lang.String + jakarta.faces.render.RenderKit + + + + + + 1981 + Register the specified RenderKit instance, associated with the specified renderKitId, to be supported by this RenderKitFactory, replacing any previously registered RenderKit for this identifier. + jakarta.faces.render + RenderKitFactory + + + java.lang.String + jakarta.faces.render.RenderKit + + + + + + + 1990__OLD + Return an Iterator over the set of render kit identifiers supported by this factory. This set must include the value specified by RenderKitFactory.DEFAULT_RENDER_KIT. + jakarta.faces.render + RenderKitFactory + + + + + 1990 + Return an Iterator over the set of render kit identifiers registered with this factory. This set must include the value specified by RenderKitFactory.HTML_BASIC_RENDER_KIT. + jakarta.faces.render + RenderKitFactory + + + + + + 2004__OLD + Return the maximum value to be enforced by this Validator, if isMaximumSet() returns true. + jakarta.faces.validator + DoubleRangeValidator + + + + + 2004 + Return the maximum value to be enforced by this Validator or Double.MAX_VALUE if it has not been set. + jakarta.faces.validator + DoubleRangeValidator + + + + + + 2005__OLD + Return the minimum value to be enforced by this Validator, if isMinimumSet() returns true. + jakarta.faces.validator + DoubleRangeValidator + + + + + 2005 + Return the minimum value to be enforced by this Validator, or Double.MIN_VALUE if it has not been set. + jakarta.faces.validator + DoubleRangeValidator + + + + + + 2014__OLD + Return the maximum length to be enforced by this Validator, if isMaximumSet() returns true. + jakarta.faces.validator + LengthValidator + + + + + 2014 + Return the maximum length to be enforced by this Validator, or 0 if the maximum has not been set. + jakarta.faces.validator + LengthValidator + + + + + + 2015__OLD + Return the minimum length to be enforced by this Validator, if isMinimumSet() returns true. + jakarta.faces.validator + LengthValidator + + + + + 2015 + Return the minimum length to be enforced by this Validator, or 0 if the minimum has not been set. + jakarta.faces.validator + LengthValidator + + + + + + 2027__OLD + Return the maximum value to be enforced by this Validator, if isMaximumSet() returns true. + jakarta.faces.validator + LongRangeValidator + + + + + 2027 + Return the maximum value to be enforced by this Validator. + jakarta.faces.validator + LongRangeValidator + + + + + + 2028__OLD + Return the minimum value to be enforced by this Validator, if isMinimumSet() returns true. + jakarta.faces.validator + LongRangeValidator + + + + + 2028 + Return the minimum value to be enforced by this Validator. + jakarta.faces.validator + LongRangeValidator + + + + + + + + 8 + if factoryName does not identify a standard JavaServer Faces factory name + jakarta.faces + FactoryFinder + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 9 + if there is no configured factory implementation class for the specified factory name + jakarta.faces + FactoryFinder + + + java.lang.String + + java.lang.IllegalStateException + + + + + 10 + if factoryname is null + jakarta.faces + FactoryFinder + + + java.lang.String + + java.lang.NullPointerException + + + + + 13 + + jakarta.faces.application + Action + + + + + 14 + Perform the task that is encapsulated in this Action instance, and return a String value that is a logical description of the outcome of performing that task. Exceptions encountered during the performance of the task should be encapsulated into appropriate return values. + jakarta.faces.application + Action + + + + + 18 + Return the PropertyResolver instance that will be utilized to resolve action and valus references. The default implementation must provide the behavior described in the PropertyResolver class description. + jakarta.faces.application + Application + + + + + 19 + Return a ValueBinding for the specified action or value reference expression, which may be used to manipulate the corresponding property value later. The returned ValueBinding instance must utilize the PropertyResolver and VariableResolver instances registered with this Application instance at the time that the ValueBinding instance was initially created. For maximum performance, implementations of Application may, but are not required to, cache ValueBinding instances in order to avoid repeated parsing of the reference expression. However, under no circumstances may a particular ValueBinding instance be shared across multiple web applications. + jakarta.faces.application + Application + + + java.lang.String + + + + + + 20 + if the specified ref has invalid syntax + jakarta.faces.application + Application + + + java.lang.String + + jakarta.faces.el.ReferenceSyntaxException + + + + + 21 + if ref is null + jakarta.faces.application + Application + + + java.lang.String + + java.lang.NullPointerException + + + + + 22 + Return the VariableResolver instance that will be utilized to resolve action and value references. The default implementation must provide the behavior described in the VariableResolver class description. + jakarta.faces.application + Application + + + + + 24 + if the specified listener does not return PhaseId.INVOKE_APPLICATION from its getPhaseId() method + jakarta.faces.application + Application + + + jakarta.faces.event.ActionListener + + java.lang.IllegalArgumentException + + + + + 25 + if listener is null + jakarta.faces.application + Application + + + jakarta.faces.event.ActionListener + + java.lang.NullPointerException + + + + + 27 + if handler is null + jakarta.faces.application + Application + + + jakarta.faces.application.NavigationHandler + + java.lang.NullPointerException + + + + + 28 + Set the PropertyResolver instance that will be utilized to resolve action and value references. + jakarta.faces.application + Application + + + jakarta.faces.el.PropertyResolver + + + + + + 29 + if resolver is null + jakarta.faces.application + Application + + + jakarta.faces.el.PropertyResolver + + java.lang.NullPointerException + + + + + 30 + Set the VariableResolver instance that will be utilized to resolve action and value references. + jakarta.faces.application + Application + + + jakarta.faces.el.VariableResolver + + + + + + 31 + if resolver is null + jakarta.faces.application + Application + + + jakarta.faces.el.VariableResolver + + java.lang.NullPointerException + + + + + 35 + Perform navigation processing based on the state information in the specified FacesContext, plus the outcome string returned by an executed Action. + jakarta.faces.application + NavigationHandler + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + 36 + if context or outcome is null + jakarta.faces.application + NavigationHandler + + + jakarta.faces.context.FacesContext + java.lang.String + + java.lang.NullPointerException + + + + + 38 + + jakarta.faces.component + AttributeDescriptor + + + + + 39 + Return a brief description of this attribute, useful when rendering help text in a tool, localized for the default Locale for this instance of the Java Virtual Machine. + jakarta.faces.component + AttributeDescriptor + + + + + 40 + Return a brief description of this attribute, useful when rendering help text in a tool, localized for the specified Locale. + jakarta.faces.component + AttributeDescriptor + + + java.util.Locale + + + + + + 41 + if locale is null + jakarta.faces.component + AttributeDescriptor + + + java.util.Locale + + java.lang.NullPointerException + + + + + 42 + Return a short displayable name of this attribute, useful in constructing the user interface of a tool, localized for the default Locale for this instance of the Java Virtual Machine. + jakarta.faces.component + AttributeDescriptor + + + + + 43 + Return a short displayable name of this attribute, useful in constructing the user interface of a tool, localized for the specified Locale. + jakarta.faces.component + AttributeDescriptor + + + java.util.Locale + + + + + + 44 + if locale is null + jakarta.faces.component + AttributeDescriptor + + + java.util.Locale + + java.lang.NullPointerException + + + + + 45 + Return the attribute name of the attribute described by this AttributeDescriptor. + jakarta.faces.component + AttributeDescriptor + + + + + 46 + Return the Java class representing the data type of the legal values for this attribute. + jakarta.faces.component + AttributeDescriptor + + + + + 47 + Add the specified UIComponent to the namespace of this naming container. + jakarta.faces.component + NamingContainer + + + jakarta.faces.component.UIComponent + + + + + + 48 + if the specified component does not have a componentId + jakarta.faces.component + NamingContainer + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 49 + if the component identifier of the specified component is not unique within the namespace of this naming container + jakarta.faces.component + NamingContainer + + + jakarta.faces.component.UIComponent + + java.lang.IllegalStateException + + + + + 50 + if component is null + jakarta.faces.component + NamingContainer + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 51 + Find and return a UIComponent in this namespace, if it is present; otherwise return null. If the argument name does not contain any UIComponent#SEPARATOR_CHAR characters, it is interpreted to be a name in the namespace of this naming container. If the argument name does contain UIComponent#SEPARATOR_CHAR characters, each segment between UIComponent#SEPARATOR_CHAR is treated as a component identifier in its own namespace, which are searched for in child naming containers of this naming container, from left to right. + jakarta.faces.component + NamingContainer + + + java.lang.String + + + + + + 52 + if name is malformed + jakarta.faces.component + NamingContainer + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 53 + if name is null + jakarta.faces.component + NamingContainer + + + java.lang.String + + java.lang.NullPointerException + + + + + 54 + Generate an identifier for a component, suitable for communication to a client. The identifier returned from this method must be unique within this namespace. + jakarta.faces.component + NamingContainer + + + + + 55 + Remove the specified UIComponent from the namespace of this naming container, if it is present. + jakarta.faces.component + NamingContainer + + + jakarta.faces.component.UIComponent + + + + + + 56 + if the specified component does not have a componentId + jakarta.faces.component + NamingContainer + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 57 + if component is null + jakarta.faces.component + NamingContainer + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 58 + Add the specified UIComponent to the namespace of this naming container. + jakarta.faces.component + NamingContainerSupport + + + jakarta.faces.component.UIComponent + + + + + + 59 + if the specified component does not have a componentId + jakarta.faces.component + NamingContainerSupport + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 60 + if the component identifier of the specified component is not unique within the namespace of this naming container + jakarta.faces.component + NamingContainerSupport + + + jakarta.faces.component.UIComponent + + java.lang.IllegalStateException + + + + + 61 + if component is null + jakarta.faces.component + NamingContainerSupport + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 62 + Find and return a UIComponent in this namespace, if it is present; otherwise return null. If the argument name does not contain any UIComponent#SEPARATOR_CHAR characters, it is interpreted to be a name in the namespace of this naming container. If the argument name does contain UIComponent#SEPARATOR_CHAR characters, each segment between UIComponent#SEPARATOR_CHAR is treated as a component identifier in its own namespace, which are searched for in child naming containers of this naming container, from left to right. + jakarta.faces.component + NamingContainerSupport + + + java.lang.String + + + + + + 63 + if name is malformed + jakarta.faces.component + NamingContainerSupport + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 64 + if name is null + jakarta.faces.component + NamingContainerSupport + + + java.lang.String + + java.lang.NullPointerException + + + + + 65 + Generate an identifier for a component, suitable for communication to a client. The identifier returned from this method must be unique within this namespace. + jakarta.faces.component + NamingContainerSupport + + + + + 66 + + jakarta.faces.component + NamingContainerSupport + + + + + 67 + Remove the specified UIComponent from the namespace of this naming container, if it is present. + jakarta.faces.component + NamingContainerSupport + + + jakarta.faces.component.UIComponent + + + + + + 68 + if the specified component does not have a componentId + jakarta.faces.component + NamingContainerSupport + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 69 + if component is null + jakarta.faces.component + NamingContainerSupport + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 70 + Return a description of this item, for use in development tools. + jakarta.faces.component + SelectItem + + + + + 71 + Return the label of this item, to be rendered visibly for the user. + jakarta.faces.component + SelectItem + + + + + 72 + Return the value of this item, to be returned as a request parameter if this item is selected by the user. + jakarta.faces.component + SelectItem + + + + + 73 + Construct a UISelectItem instance with the specified property values. + jakarta.faces.component + SelectItem + + + java.lang.Object + java.lang.String + java.lang.String + + + + + + 75 + if listener is null + jakarta.faces.component + UICommand + + + jakarta.faces.event.ActionListener + + java.lang.NullPointerException + + + + + 76 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type, for the specified PhaseId. The order in which registered listeners are notified is implementation dependent. After all interested listeners have been notified, return false if this event does not have any listeners interested in this event in future phases of the request processing lifecycle. Otherwise, return true. + jakarta.faces.component + UICommand + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + + + + + 77 + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UICommand + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + jakarta.faces.event.AbortProcessingException + + + + + 78 + if the implementation class of this FacesEvent is not supported by this component + jakarta.faces.component + UICommand + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalArgumentException + + + + + 79 + if PhaseId.ANY_PHASE is passed for the phase identifier + jakarta.faces.component + UICommand + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalStateException + + + + + 80 + if event or phaseId is null + jakarta.faces.component + UICommand + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.NullPointerException + + + + + 81 + Queue an ActionEvent for processing during the next event processing cycle. + jakarta.faces.component + UICommand + + + jakarta.faces.context.FacesContext + + + + + + 82 + Return the literal action outcome value to be returned to the jakarta.faces.event.ActionListener processing application level events for this application. + jakarta.faces.component + UICommand + + + + + 83 + Return the action reference expression pointing at the jakarta.faces.application.Action to be invoked, if this component is activated by the user, during Invoke Application phase of the request processing lifecycle. + jakarta.faces.component + UICommand + + + + + 84 + Return the command name for this UICommand. + jakarta.faces.component + UICommand + + + + + 85 + Return the component type of this UIComponent. + jakarta.faces.component + UICommand + + + + + 87 + if listener is null + jakarta.faces.component + UICommand + + + jakarta.faces.event.ActionListener + + java.lang.NullPointerException + + + + + 88 + Set the literal action outcome value for this component. + jakarta.faces.component + UICommand + + + java.lang.String + + + + + + 89 + Set the action reference expression pointing at the jakarta.faces.application.Action to be invoked, if this component is activated by the user, during Invoke Application phase of the request processing lifecycle. + jakarta.faces.component + UICommand + + + java.lang.String + + + + + + 90 + Set the command name for this UICommand. + jakarta.faces.component + UICommand + + + java.lang.String + + + + + + 92 + Override the default behavior and perform no model update. + jakarta.faces.component + UICommand + + + jakarta.faces.context.FacesContext + + + + + + 93 + if the modelReference property has invalid syntax for an expression + jakarta.faces.component + UICommand + + + jakarta.faces.context.FacesContext + + java.lang.IllegalArgumentException + + + + + 94 + if context is null + jakarta.faces.component + UICommand + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 95 + Append the specified UIComponent to the end of the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 96 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 97 + if component is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 98 + Insert the specified UIComponent at the specified position in the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + + + + + 99 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 100 + if the index is out of range ((index < 0) || (index > size())) + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IndexOutOfBoundsException + + + + + 101 + if component is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 102 + Add the specified UIComponent as a facet associated with the name specified by the facetName argument, replacing any previous facet with that name. The newly added facet will have its parent property set to this component. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + 103 + if the either of the facetName or facet arguments are null. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 104 + Add a Validator instance to the set associated with this UIComponent. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 105 + if validator is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + java.lang.NullPointerException + + + + + 106 + Remove all child UIComponents from the child list. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 107 + Remove all facet UIComponents from this component. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 108 + Clear any Validators that have been registered for processing by this component. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 109 + Return true if the specified UIComponent is a direct child of this UIComponent; otherwise, return false. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 110 + if component is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 111 + Decode the current state of this UIComponent from the request contained in the specified FacesContext, and attempt to convert this state information into an object of the required type for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one. If conversion is successful: Save the new local value of this component by calling setValue() and passing the new value. Set the valid property of this component to true. If conversion is not successful: Save state information in such a way that encoding can reproduce the previous input (even though it was syntactically or semantically incorrect) Add an appropriate conversion failure error message by calling context.addMessage(). Set the valid property of this comonent to false. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 112 + if an input/output error occurs during decoding + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 113 + if context is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 114 + Render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. If the conversion attempted in a previous call to decode() for this component failed, the state information saved during execution of decode() should be utilized to reproduce the incorrect input. If the conversion was successful, or if there was no previous call to decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the value as appropriate. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 115 + if an input/output error occurs while rendering + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 116 + if context is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 117 + Render the child UIComponents of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property is true. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 118 + if an input/output error occurs while rendering + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 119 + if context is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 120 + Render the ending of the current state of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 121 + if an input/output error occurs while rendering + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 122 + if context is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 123 + Find the UIComponent named by the specified expression, if any is found. This is done by locating the closest parent UIComponent that is a NamingContainer, and calling its findComponentInNamespace() method. The specified expr may contain either a component identifier, or a set of component identifiers separated by SEPARATOR_CHAR characters. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 124 + if expr is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 125 + Return the value of the attribute with the specified name (if any); otherwise, return null. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 126 + if name is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 127 + Return an Iterator over the names of all currently defined attributes of this UIComponent that have a non-null value. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 128 + Return the UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 129 + if index is out of range ((index = size())) + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 130 + Return the number of UIComponents on the child list for this component. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 131 + Return an Iterator over the child UIComponents of this UIComponent, in the order of their position in the child list. If this component has no children, an empty Iterator is returned. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 132 + Return a client-side identifier for this component, generating one if necessary. Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 133 + if context is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 134 + Return the identifier of this UIComponent. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 135 + Return the converter id of the jakarta.faces.convert.Converter that is registered for this component. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 136 + Return the facet UIComponent associated with the specified name, if any. Otherwise, return null. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 137 + if name is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 138 + Return an Iterator over the names of the facet UIComponents of this UIComponent. If this component has no facets, an empty Iterator is returned. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 139 + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 140 + Return the parent UIComponent of this UIComponent, if any. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 141 + Return the Renderer type for this UIComponent (if any). + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 142 + Return a flag indicating whether this component is responsible for rendering its child components. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 143 + Return a flag indicating whether this component has concrete implementations of the decode() and encodeXxx() methods, and is therefore suitable for use in the direct implementation programming model for rendering. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 144 + Return an Iterator over the Validators associated with this UIComponent. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 145 + Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 146 + Return the current validity state of this component. The validity state of a component is adjusted at the following points during the request processing lifecycle: During the Apply Request Values phase, set to true or false by decode(), based on the success or failure of decoding a new local value for this component. During the Process Validations phase, set to false by processValidations() if any call to a validate() method returned false. During the Update Model Values phase, set to false by updateModel() if any conversion or update error occurred. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + + + 147 + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 148 + if an input/output error occurs during decoding + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 149 + if context is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 150 + Perform the component tree processing required by the Reconstitute Component Tree phase of the request processing lifecyc,e for all facets of this component, all children of this component, and this component itself, as follows. Call the processReconstitutes() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). Call the reconstitute() method of this component. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 151 + if an input/output error occurs during processing + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 152 + if context is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 153 + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the updateModel() method of this component. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 154 + if context is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 155 + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property of this component is currently true: Call the validate() method of each Validator registered for this UIComponent. Call the validate() method of this component. Set the valid property of this component to the result returned from the validate() method. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 156 + if context is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 157 + Perform any processing required to correct the state of this component as a result of the owning component tree having been reconstructed during Reconstitute Component Tree phase of the request processing lifecycle. The default implementation of this method does nothing. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 158 + if an input/output error occurs during processing + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 159 + if context is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 160 + Remove the child UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 161 + if the index is out of range ((index < 0) || (index >= size())) + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 162 + Remove the child UIComponent from the child list for this component. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 163 + if component is not a child of this component + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 164 + if component is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 165 + Remove the facet UIComponent associated with the specified name, if there is one. The removed facet will have its parent property cleared. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 166 + if name is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 167 + Remove a Validator instance from the set associated with this UIComponent, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 168 + Set the new value of the attribute with the specified name, replacing any existing value for that name. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + + + + + 169 + if name represents a read-only property of this component + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalArgumentException + + + + + 170 + if name is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 171 + Set the identifier of this UIComponent. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 172 + if componentId is zero length or contains invalid characters + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 173 + if componentId is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 174 + if this UIComponent instance is already in the tree and and is not unique within the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 175 + Set the converter id of the jakarta.faces.convert.Converter that is registered for this component, or null to indicate that there is no registered Converter. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 176 + Set the parent UIComponent of this UIComponent. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 177 + Set the rendered property of this UIComponent. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 178 + Set the Renderer type for this UIComponent, or null for components that render themselves. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 179 + Set the current validity state of this component. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 180 + Perform any correctness checks that this component wishes to perform on itself. This method will be called during the Process Validations phase of the request processing lifecycle. If errors are encountered, appropriate Message instances should be added to the FacesContext for the current request, and the valid property of this UIComponent should be set to false. + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 181 + if context is null + jakarta.faces.component + UICommand.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 182 + Append the specified UIComponent to the end of the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIComponent + + + jakarta.faces.component.UIComponent + + + + + + 183 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIComponent + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 184 + if component is null + jakarta.faces.component + UIComponent + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 185 + Insert the specified UIComponent at the specified position in the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIComponent + + + int + jakarta.faces.component.UIComponent + + + + + + 186 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIComponent + + + int + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 187 + if the index is out of range ((index < 0) || (index > size())) + jakarta.faces.component + UIComponent + + + int + jakarta.faces.component.UIComponent + + java.lang.IndexOutOfBoundsException + + + + + 188 + if component is null + jakarta.faces.component + UIComponent + + + int + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 189 + Add the specified UIComponent as a facet associated with the name specified by the facetName argument, replacing any previous facet with that name. The newly added facet will have its parent property set to this component. + jakarta.faces.component + UIComponent + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + 190 + if the either of the facetName or facet arguments are null. + jakarta.faces.component + UIComponent + + + java.lang.String + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 191 + Add a Validator instance to the set associated with this UIComponent. + jakarta.faces.component + UIComponent + + + jakarta.faces.validator.Validator + + + + + + 192 + if validator is null + jakarta.faces.component + UIComponent + + + jakarta.faces.validator.Validator + + java.lang.NullPointerException + + + + + 193 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type, for the specified PhaseId (or for any phase, if the listener returns PhaseId.ANY_PHASE from its getPhaseId() method. The order in which registered listeners are notified is implementation dependent. After all interested listeners have been notified, return false if this event does not have any listeners interested in this event in future phases of the request processing lifecycle. Otherwise, return true. + jakarta.faces.component + UIComponent + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + + + + + 194 + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UIComponent + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + jakarta.faces.event.AbortProcessingException + + + + + 195 + if the implementation class of this FacesEvent is not supported by this component + jakarta.faces.component + UIComponent + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalArgumentException + + + + + 196 + if PhaseId.ANY_PHASE is passed for the phase identifier + jakarta.faces.component + UIComponent + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalStateException + + + + + 197 + if event or phaseId is null + jakarta.faces.component + UIComponent + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.NullPointerException + + + + + 198 + Remove all child UIComponents from the child list. + jakarta.faces.component + UIComponent + + + + + 199 + Remove all facet UIComponents from this component. + jakarta.faces.component + UIComponent + + + + + 200 + Clear any Validators that have been registered for processing by this component. + jakarta.faces.component + UIComponent + + + + + 201 + Return true if the specified UIComponent is a direct child of this UIComponent; otherwise, return false. + jakarta.faces.component + UIComponent + + + jakarta.faces.component.UIComponent + + + + + + 202 + if component is null + jakarta.faces.component + UIComponent + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 204 + if an input/output error occurs during decoding + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 205 + if context is null + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 208 + if context is null + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 211 + if context is null + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 214 + if context is null + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 216 + if expr is null + jakarta.faces.component + UIComponent + + + java.lang.String + + java.lang.NullPointerException + + + + + 217 + Return the value of the attribute with the specified name (if any); otherwise, return null. + jakarta.faces.component + UIComponent + + + java.lang.String + + + + + + 218 + if name is null + jakarta.faces.component + UIComponent + + + java.lang.String + + java.lang.NullPointerException + + + + + 219 + Return an Iterator over the names of all currently defined attributes of this UIComponent that have a non-null value. + jakarta.faces.component + UIComponent + + + + + 220 + Return the UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UIComponent + + + int + + + + + + 221 + if index is out of range ((index = size())) + jakarta.faces.component + UIComponent + + + int + + java.lang.IndexOutOfBoundsException + + + + + 223 + Return an Iterator over the child UIComponents of this UIComponent, in the order of their position in the child list. If this component has no children, an empty Iterator is returned. + jakarta.faces.component + UIComponent + + + + + 225 + if context is null + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 226 + Return the identifier of this UIComponent. + jakarta.faces.component + UIComponent + + + + + 227 + Return the component type of this UIComponent. + jakarta.faces.component + UIComponent + + + + + 228 + Return the converter id of the jakarta.faces.convert.Converter that is registered for this component. + jakarta.faces.component + UIComponent + + + + + 230 + if name is null + jakarta.faces.component + UIComponent + + + java.lang.String + + java.lang.NullPointerException + + + + + 231 + Return an Iterator over the names of the facet UIComponents of this UIComponent. If this component has no facets, an empty Iterator is returned. + jakarta.faces.component + UIComponent + + + + + 236 + Return a flag indicating whether this component has concrete implementations of the decode() and encodeXxx() methods, and is therefore suitable for use in the direct implementation programming model for rendering. + jakarta.faces.component + UIComponent + + + + + 237 + Return an Iterator over the Validators associated with this UIComponent. + jakarta.faces.component + UIComponent + + + + + 239 + Return the current validity state of this component. The validity state of a component is adjusted at the following points during the request processing lifecycle: During the Apply Request Values phase, set to true or false by decode(), based on the success or failure of decoding a new local value for this component. During the Process Validations phase, set to false by processValidations() if any call to a validate() method returned false. During the Update Model Values phase, set to false by updateModel() if any conversion or update error occurred. + jakarta.faces.component + UIComponent + + + + + 241 + if an input/output error occurs during decoding + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 242 + if context is null + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 243 + Perform the component tree processing required by the Reconstitute Component Tree phase of the request processing lifecyc,e for all facets of this component, all children of this component, and this component itself, as follows. Call the processReconstitutes() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). Call the reconstitute() method of this component. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + 244 + if an input/output error occurs during processing + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 245 + if context is null + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 247 + if context is null + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 249 + if context is null + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 250 + Perform any processing required to correct the state of this component as a result of the owning component tree having been reconstructed during Reconstitute Component Tree phase of the request processing lifecycle. The default implementation of this method does nothing. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + 251 + if an input/output error occurs during processing + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 252 + if context is null + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 253 + Remove the child UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UIComponent + + + int + + + + + + 254 + if the index is out of range ((index < 0) || (index >= size())) + jakarta.faces.component + UIComponent + + + int + + java.lang.IndexOutOfBoundsException + + + + + 255 + Remove the child UIComponent from the child list for this component. + jakarta.faces.component + UIComponent + + + jakarta.faces.component.UIComponent + + + + + + 256 + if component is not a child of this component + jakarta.faces.component + UIComponent + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 257 + if component is null + jakarta.faces.component + UIComponent + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 258 + Remove the facet UIComponent associated with the specified name, if there is one. The removed facet will have its parent property cleared. + jakarta.faces.component + UIComponent + + + java.lang.String + + + + + + 259 + if name is null + jakarta.faces.component + UIComponent + + + java.lang.String + + java.lang.NullPointerException + + + + + 260 + Remove a Validator instance from the set associated with this UIComponent, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + UIComponent + + + jakarta.faces.validator.Validator + + + + + + 261 + Set the new value of the attribute with the specified name, replacing any existing value for that name. + jakarta.faces.component + UIComponent + + + java.lang.String + java.lang.Object + + + + + + 262 + if name represents a read-only property of this component + jakarta.faces.component + UIComponent + + + java.lang.String + java.lang.Object + + java.lang.IllegalArgumentException + + + + + 263 + if name is null + jakarta.faces.component + UIComponent + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 264 + Set the identifier of this UIComponent. + jakarta.faces.component + UIComponent + + + java.lang.String + + + + + + 265 + if componentId is zero length or contains invalid characters + jakarta.faces.component + UIComponent + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 266 + if componentId is null + jakarta.faces.component + UIComponent + + + java.lang.String + + java.lang.NullPointerException + + + + + 267 + if this UIComponent instance is already in the tree and and is not unique within the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIComponent + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 268 + Set the converter id of the jakarta.faces.convert.Converter that is registered for this component, or null to indicate that there is no registered Converter. + jakarta.faces.component + UIComponent + + + java.lang.String + + + + + + 272 + Set the current validity state of this component. + jakarta.faces.component + UIComponent + + + boolean + + + + + + 273 + Update the model data associated with this UIComponent, if any. The default implementation in UIComponentBase does no processing; concrete implementations of components that represent controls that can be altered by users (such as UIInput must provide an apppropriate implementation of this method. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + 274 + if context is null + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 275 + Perform any correctness checks that this component wishes to perform on itself. This method will be called during the Process Validations phase of the request processing lifecycle. If errors are encountered, appropriate Message instances should be added to the FacesContext for the current request, and the valid property of this UIComponent should be set to false. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + 276 + if context is null + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 277 + Append the specified UIComponent to the end of the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.component.UIComponent + + + + + + 278 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 279 + if component is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 280 + Insert the specified UIComponent at the specified position in the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIComponentBase + + + int + jakarta.faces.component.UIComponent + + + + + + 281 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIComponentBase + + + int + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 282 + if the index is out of range ((index < 0) || (index > size())) + jakarta.faces.component + UIComponentBase + + + int + jakarta.faces.component.UIComponent + + java.lang.IndexOutOfBoundsException + + + + + 283 + if component is null + jakarta.faces.component + UIComponentBase + + + int + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 284 + Add the specified UIComponent as a facet associated with the name specified by the facetName argument, replacing any previous facet with that name. The newly added facet will have its parent property set to this component. + jakarta.faces.component + UIComponentBase + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + 285 + if the either of the facetName or facet arguments are null. + jakarta.faces.component + UIComponentBase + + + java.lang.String + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 286 + Add a Validator instance to the set associated with this UIComponent. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.validator.Validator + + + + + + 287 + if validator is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.validator.Validator + + java.lang.NullPointerException + + + + + 288 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type, for the specified PhaseId (or for any phase, if the listener returns PhaseId.ANY_PHASE from its getPhaseId() method. The order in which registered listeners are notified is implementation dependent. After all interested listeners have been notified, return false if this event does not have any listeners interested in this event in future phases of the request processing lifecycle. Otherwise, return true. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + + + + + 289 + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UIComponentBase + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + jakarta.faces.event.AbortProcessingException + + + + + 290 + if the implementation class of this FacesEvent is not supported by this component + jakarta.faces.component + UIComponentBase + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalArgumentException + + + + + 291 + if PhaseId.ANY_PHASE is passed for the phase identifier + jakarta.faces.component + UIComponentBase + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalStateException + + + + + 292 + if event or phaseId is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.NullPointerException + + + + + 293 + Remove all child UIComponents from the child list. + jakarta.faces.component + UIComponentBase + + + + + 294 + Remove all facet UIComponents from this component. + jakarta.faces.component + UIComponentBase + + + + + 295 + Clear any Validators that have been registered for processing by this component. + jakarta.faces.component + UIComponentBase + + + + + 296 + Return true if the specified UIComponent is a direct child of this UIComponent; otherwise, return false. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.component.UIComponent + + + + + + 297 + if component is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 299 + if an input/output error occurs during decoding + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 300 + if context is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 303 + if context is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 306 + if context is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 309 + if context is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 311 + if expr is null + jakarta.faces.component + UIComponentBase + + + java.lang.String + + java.lang.NullPointerException + + + + + 312 + Return the value of the attribute with the specified name (if any); otherwise, return null. + jakarta.faces.component + UIComponentBase + + + java.lang.String + + + + + + 313 + if name is null + jakarta.faces.component + UIComponentBase + + + java.lang.String + + java.lang.NullPointerException + + + + + 314 + Return an Iterator over the names of all currently defined attributes of this UIComponent that have a non-null value. + jakarta.faces.component + UIComponentBase + + + + + 315 + Return the UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UIComponentBase + + + int + + + + + + 316 + if index is out of range ((index = size())) + jakarta.faces.component + UIComponentBase + + + int + + java.lang.IndexOutOfBoundsException + + + + + 318 + Return an Iterator over the child UIComponents of this UIComponent, in the order of their position in the child list. If this component has no children, an empty Iterator is returned. + jakarta.faces.component + UIComponentBase + + + + + 320 + if context is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 321 + Return the identifier of this UIComponent. + jakarta.faces.component + UIComponentBase + + + + + 322 + Return the component type of this UIComponent. + jakarta.faces.component + UIComponentBase + + + + + 323 + Return the converter id of the jakarta.faces.convert.Converter that is registered for this component. + jakarta.faces.component + UIComponentBase + + + + + 325 + if name is null + jakarta.faces.component + UIComponentBase + + + java.lang.String + + java.lang.NullPointerException + + + + + 326 + Return an Iterator over the names of the facet UIComponents of this UIComponent. If this component has no facets, an empty Iterator is returned. + jakarta.faces.component + UIComponentBase + + + + + 331 + Return a flag indicating whether this component has concrete implementations of the decode() and encodeXxx() methods, and is therefore suitable for use in the direct implementation programming model for rendering. + jakarta.faces.component + UIComponentBase + + + + + 332 + Return an Iterator over the Validators associated with this UIComponent. + jakarta.faces.component + UIComponentBase + + + + + 334 + Return the current validity state of this component. The validity state of a component is adjusted at the following points during the request processing lifecycle: During the Apply Request Values phase, set to true or false by decode(), based on the success or failure of decoding a new local value for this component. During the Process Validations phase, set to false by processValidations() if any call to a validate() method returned false. During the Update Model Values phase, set to false by updateModel() if any conversion or update error occurred. + jakarta.faces.component + UIComponentBase + + + + + 336 + if an input/output error occurs during decoding + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 337 + if context is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 338 + Perform the component tree processing required by the Reconstitute Component Tree phase of the request processing lifecyc,e for all facets of this component, all children of this component, and this component itself, as follows. Call the processReconstitutes() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). Call the reconstitute() method of this component. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + 339 + if an input/output error occurs during processing + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 340 + if context is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 342 + if context is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 344 + if context is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 345 + Perform any processing required to correct the state of this component as a result of the owning component tree having been reconstructed during Reconstitute Component Tree phase of the request processing lifecycle. The default implementation of this method does nothing. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + 346 + if an input/output error occurs during processing + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 347 + if context is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 348 + Remove the child UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UIComponentBase + + + int + + + + + + 349 + if the index is out of range ((index < 0) || (index >= size())) + jakarta.faces.component + UIComponentBase + + + int + + java.lang.IndexOutOfBoundsException + + + + + 350 + Remove the child UIComponent from the child list for this component. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.component.UIComponent + + + + + + 351 + if component is not a child of this component + jakarta.faces.component + UIComponentBase + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 352 + if component is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 353 + Remove the facet UIComponent associated with the specified name, if there is one. The removed facet will have its parent property cleared. + jakarta.faces.component + UIComponentBase + + + java.lang.String + + + + + + 354 + if name is null + jakarta.faces.component + UIComponentBase + + + java.lang.String + + java.lang.NullPointerException + + + + + 355 + Remove a Validator instance from the set associated with this UIComponent, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.validator.Validator + + + + + + 356 + Set the new value of the attribute with the specified name, replacing any existing value for that name. + jakarta.faces.component + UIComponentBase + + + java.lang.String + java.lang.Object + + + + + + 357 + if name represents a read-only property of this component + jakarta.faces.component + UIComponentBase + + + java.lang.String + java.lang.Object + + java.lang.IllegalArgumentException + + + + + 358 + if name is null + jakarta.faces.component + UIComponentBase + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 359 + Set the identifier of this UIComponent. + jakarta.faces.component + UIComponentBase + + + java.lang.String + + + + + + 360 + if componentId is zero length or contains invalid characters + jakarta.faces.component + UIComponentBase + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 361 + if componentId is null + jakarta.faces.component + UIComponentBase + + + java.lang.String + + java.lang.NullPointerException + + + + + 362 + if this UIComponent instance is already in the tree and and is not unique within the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIComponentBase + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 363 + Set the converter id of the jakarta.faces.convert.Converter that is registered for this component, or null to indicate that there is no registered Converter. + jakarta.faces.component + UIComponentBase + + + java.lang.String + + + + + + 367 + Set the current validity state of this component. + jakarta.faces.component + UIComponentBase + + + boolean + + + + + + 369 + Update the model data associated with this UIComponent, if any. The default implementation in UIComponentBase does no processing; concrete implementations of components that represent controls that can be altered by users (such as UIInput must provide an apppropriate implementation of this method. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + 370 + if context is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 371 + Perform any correctness checks that this component wishes to perform on itself. This method will be called during the Process Validations phase of the request processing lifecycle. If errors are encountered, appropriate Message instances should be added to the FacesContext for the current request, and the valid property of this UIComponent should be set to false. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + 372 + if context is null + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 373 + Return the component type of this UIComponent. + jakarta.faces.component + UIForm + + + + + 374 + Return the form name for this UIForm. + jakarta.faces.component + UIForm + + + + + 375 + Set the form name for this UIForm. + jakarta.faces.component + UIForm + + + java.lang.String + + + + + + 377 + Append the specified UIComponent to the end of the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 378 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 379 + if component is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 380 + Insert the specified UIComponent at the specified position in the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + + + + + 381 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 382 + if the index is out of range ((index < 0) || (index > size())) + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IndexOutOfBoundsException + + + + + 383 + if component is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 384 + Add the specified UIComponent as a facet associated with the name specified by the facetName argument, replacing any previous facet with that name. The newly added facet will have its parent property set to this component. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + 385 + if the either of the facetName or facet arguments are null. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 386 + Add a Validator instance to the set associated with this UIComponent. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 387 + if validator is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + java.lang.NullPointerException + + + + + 388 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type, for the specified PhaseId (or for any phase, if the listener returns PhaseId.ANY_PHASE from its getPhaseId() method. The order in which registered listeners are notified is implementation dependent. After all interested listeners have been notified, return false if this event does not have any listeners interested in this event in future phases of the request processing lifecycle. Otherwise, return true. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + + + + + 389 + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + jakarta.faces.event.AbortProcessingException + + + + + 390 + if the implementation class of this FacesEvent is not supported by this component + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalArgumentException + + + + + 391 + if PhaseId.ANY_PHASE is passed for the phase identifier + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalStateException + + + + + 392 + if event or phaseId is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.NullPointerException + + + + + 393 + Remove all child UIComponents from the child list. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 394 + Remove all facet UIComponents from this component. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 395 + Clear any Validators that have been registered for processing by this component. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 396 + Return true if the specified UIComponent is a direct child of this UIComponent; otherwise, return false. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 397 + if component is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 398 + Decode the current state of this UIComponent from the request contained in the specified FacesContext, and attempt to convert this state information into an object of the required type for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one. If conversion is successful: Save the new local value of this component by calling setValue() and passing the new value. Set the valid property of this component to true. If conversion is not successful: Save state information in such a way that encoding can reproduce the previous input (even though it was syntactically or semantically incorrect) Add an appropriate conversion failure error message by calling context.addMessage(). Set the valid property of this comonent to false. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 399 + if an input/output error occurs during decoding + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 400 + if context is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 401 + Render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. If the conversion attempted in a previous call to decode() for this component failed, the state information saved during execution of decode() should be utilized to reproduce the incorrect input. If the conversion was successful, or if there was no previous call to decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the value as appropriate. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 402 + if an input/output error occurs while rendering + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 403 + if context is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 404 + Render the child UIComponents of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property is true. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 405 + if an input/output error occurs while rendering + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 406 + if context is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 407 + Render the ending of the current state of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 408 + if an input/output error occurs while rendering + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 409 + if context is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 410 + Find the UIComponent named by the specified expression, if any is found. This is done by locating the closest parent UIComponent that is a NamingContainer, and calling its findComponentInNamespace() method. The specified expr may contain either a component identifier, or a set of component identifiers separated by SEPARATOR_CHAR characters. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 411 + if expr is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 412 + Return the value of the attribute with the specified name (if any); otherwise, return null. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 413 + if name is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 414 + Return an Iterator over the names of all currently defined attributes of this UIComponent that have a non-null value. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 415 + Return the UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 416 + if index is out of range ((index = size())) + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 417 + Return the number of UIComponents on the child list for this component. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 418 + Return an Iterator over the child UIComponents of this UIComponent, in the order of their position in the child list. If this component has no children, an empty Iterator is returned. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 419 + Return a client-side identifier for this component, generating one if necessary. Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 420 + if context is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 421 + Return the identifier of this UIComponent. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 422 + Return the converter id of the jakarta.faces.convert.Converter that is registered for this component. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 423 + Return the facet UIComponent associated with the specified name, if any. Otherwise, return null. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 424 + if name is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 425 + Return an Iterator over the names of the facet UIComponents of this UIComponent. If this component has no facets, an empty Iterator is returned. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 426 + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 427 + Return the parent UIComponent of this UIComponent, if any. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 428 + Return the Renderer type for this UIComponent (if any). + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 429 + Return a flag indicating whether this component is responsible for rendering its child components. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 430 + Return a flag indicating whether this component has concrete implementations of the decode() and encodeXxx() methods, and is therefore suitable for use in the direct implementation programming model for rendering. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 431 + Return an Iterator over the Validators associated with this UIComponent. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 432 + Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 433 + Return the current validity state of this component. The validity state of a component is adjusted at the following points during the request processing lifecycle: During the Apply Request Values phase, set to true or false by decode(), based on the success or failure of decoding a new local value for this component. During the Process Validations phase, set to false by processValidations() if any call to a validate() method returned false. During the Update Model Values phase, set to false by updateModel() if any conversion or update error occurred. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + + + 434 + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 435 + if an input/output error occurs during decoding + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 436 + if context is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 437 + Perform the component tree processing required by the Reconstitute Component Tree phase of the request processing lifecyc,e for all facets of this component, all children of this component, and this component itself, as follows. Call the processReconstitutes() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). Call the reconstitute() method of this component. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 438 + if an input/output error occurs during processing + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 439 + if context is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 440 + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the updateModel() method of this component. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 441 + if context is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 442 + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property of this component is currently true: Call the validate() method of each Validator registered for this UIComponent. Call the validate() method of this component. Set the valid property of this component to the result returned from the validate() method. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 443 + if context is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 444 + Perform any processing required to correct the state of this component as a result of the owning component tree having been reconstructed during Reconstitute Component Tree phase of the request processing lifecycle. The default implementation of this method does nothing. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 445 + if an input/output error occurs during processing + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 446 + if context is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 447 + Remove the child UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 448 + if the index is out of range ((index < 0) || (index >= size())) + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 449 + Remove the child UIComponent from the child list for this component. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 450 + if component is not a child of this component + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 451 + if component is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 452 + Remove the facet UIComponent associated with the specified name, if there is one. The removed facet will have its parent property cleared. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 453 + if name is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 454 + Remove a Validator instance from the set associated with this UIComponent, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 455 + Set the new value of the attribute with the specified name, replacing any existing value for that name. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + + + + + 456 + if name represents a read-only property of this component + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalArgumentException + + + + + 457 + if name is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 458 + Set the identifier of this UIComponent. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 459 + if componentId is zero length or contains invalid characters + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 460 + if componentId is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 461 + if this UIComponent instance is already in the tree and and is not unique within the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 462 + Set the converter id of the jakarta.faces.convert.Converter that is registered for this component, or null to indicate that there is no registered Converter. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 463 + Set the parent UIComponent of this UIComponent. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 464 + Set the rendered property of this UIComponent. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 465 + Set the Renderer type for this UIComponent, or null for components that render themselves. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 466 + Set the current validity state of this component. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 467 + Update the model data associated with this UIComponent, if any. The default implementation in UIComponentBase does no processing; concrete implementations of components that represent controls that can be altered by users (such as UIInput must provide an apppropriate implementation of this method. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 468 + if context is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 469 + Perform any correctness checks that this component wishes to perform on itself. This method will be called during the Process Validations phase of the request processing lifecycle. If errors are encountered, appropriate Message instances should be added to the FacesContext for the current request, and the valid property of this UIComponent should be set to false. + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 470 + if context is null + jakarta.faces.component + UIForm.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 471 + Return the component type of this UIComponent. + jakarta.faces.component + UIGraphic + + + + + 472 + Return the image URL for this UIGraphic. + jakarta.faces.component + UIGraphic + + + + + 473 + Set the image URL for this UIGraphic. + jakarta.faces.component + UIGraphic + + + java.lang.String + + + + + + 475 + Append the specified UIComponent to the end of the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 476 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 477 + if component is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 478 + Insert the specified UIComponent at the specified position in the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + + + + + 479 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 480 + if the index is out of range ((index < 0) || (index > size())) + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IndexOutOfBoundsException + + + + + 481 + if component is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 482 + Add the specified UIComponent as a facet associated with the name specified by the facetName argument, replacing any previous facet with that name. The newly added facet will have its parent property set to this component. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + 483 + if the either of the facetName or facet arguments are null. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 484 + Add a Validator instance to the set associated with this UIComponent. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 485 + if validator is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + java.lang.NullPointerException + + + + + 486 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type, for the specified PhaseId (or for any phase, if the listener returns PhaseId.ANY_PHASE from its getPhaseId() method. The order in which registered listeners are notified is implementation dependent. After all interested listeners have been notified, return false if this event does not have any listeners interested in this event in future phases of the request processing lifecycle. Otherwise, return true. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + + + + + 487 + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + jakarta.faces.event.AbortProcessingException + + + + + 488 + if the implementation class of this FacesEvent is not supported by this component + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalArgumentException + + + + + 489 + if PhaseId.ANY_PHASE is passed for the phase identifier + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalStateException + + + + + 490 + if event or phaseId is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.NullPointerException + + + + + 491 + Remove all child UIComponents from the child list. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 492 + Remove all facet UIComponents from this component. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 493 + Clear any Validators that have been registered for processing by this component. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 494 + Return true if the specified UIComponent is a direct child of this UIComponent; otherwise, return false. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 495 + if component is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 496 + Decode the current state of this UIComponent from the request contained in the specified FacesContext, and attempt to convert this state information into an object of the required type for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one. If conversion is successful: Save the new local value of this component by calling setValue() and passing the new value. Set the valid property of this component to true. If conversion is not successful: Save state information in such a way that encoding can reproduce the previous input (even though it was syntactically or semantically incorrect) Add an appropriate conversion failure error message by calling context.addMessage(). Set the valid property of this comonent to false. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 497 + if an input/output error occurs during decoding + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 498 + if context is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 499 + Render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. If the conversion attempted in a previous call to decode() for this component failed, the state information saved during execution of decode() should be utilized to reproduce the incorrect input. If the conversion was successful, or if there was no previous call to decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the value as appropriate. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 500 + if an input/output error occurs while rendering + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 501 + if context is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 502 + Render the child UIComponents of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property is true. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 503 + if an input/output error occurs while rendering + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 504 + if context is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 505 + Render the ending of the current state of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 506 + if an input/output error occurs while rendering + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 507 + if context is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 508 + Find the UIComponent named by the specified expression, if any is found. This is done by locating the closest parent UIComponent that is a NamingContainer, and calling its findComponentInNamespace() method. The specified expr may contain either a component identifier, or a set of component identifiers separated by SEPARATOR_CHAR characters. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 509 + if expr is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 510 + Return the value of the attribute with the specified name (if any); otherwise, return null. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 511 + if name is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 512 + Return an Iterator over the names of all currently defined attributes of this UIComponent that have a non-null value. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 513 + Return the UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 514 + if index is out of range ((index = size())) + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 515 + Return the number of UIComponents on the child list for this component. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 516 + Return an Iterator over the child UIComponents of this UIComponent, in the order of their position in the child list. If this component has no children, an empty Iterator is returned. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 517 + Return a client-side identifier for this component, generating one if necessary. Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 518 + if context is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 519 + Return the identifier of this UIComponent. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 520 + Return the component type of this UIComponent. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 521 + Return the converter id of the jakarta.faces.convert.Converter that is registered for this component. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 522 + Return the facet UIComponent associated with the specified name, if any. Otherwise, return null. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 523 + if name is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 524 + Return an Iterator over the names of the facet UIComponents of this UIComponent. If this component has no facets, an empty Iterator is returned. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 525 + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 526 + Return the parent UIComponent of this UIComponent, if any. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 527 + Return the Renderer type for this UIComponent (if any). + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 528 + Return a flag indicating whether this component is responsible for rendering its child components. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 529 + Return a flag indicating whether this component has concrete implementations of the decode() and encodeXxx() methods, and is therefore suitable for use in the direct implementation programming model for rendering. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 530 + Return an Iterator over the Validators associated with this UIComponent. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 531 + Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 532 + Return the current validity state of this component. The validity state of a component is adjusted at the following points during the request processing lifecycle: During the Apply Request Values phase, set to true or false by decode(), based on the success or failure of decoding a new local value for this component. During the Process Validations phase, set to false by processValidations() if any call to a validate() method returned false. During the Update Model Values phase, set to false by updateModel() if any conversion or update error occurred. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + + + 533 + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 534 + if an input/output error occurs during decoding + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 535 + if context is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 536 + Perform the component tree processing required by the Reconstitute Component Tree phase of the request processing lifecyc,e for all facets of this component, all children of this component, and this component itself, as follows. Call the processReconstitutes() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). Call the reconstitute() method of this component. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 537 + if an input/output error occurs during processing + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 538 + if context is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 539 + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the updateModel() method of this component. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 540 + if context is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 541 + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property of this component is currently true: Call the validate() method of each Validator registered for this UIComponent. Call the validate() method of this component. Set the valid property of this component to the result returned from the validate() method. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 542 + if context is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 543 + Perform any processing required to correct the state of this component as a result of the owning component tree having been reconstructed during Reconstitute Component Tree phase of the request processing lifecycle. The default implementation of this method does nothing. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 544 + if an input/output error occurs during processing + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 545 + if context is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 546 + Remove the child UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 547 + if the index is out of range ((index < 0) || (index >= size())) + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 548 + Remove the child UIComponent from the child list for this component. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 549 + if component is not a child of this component + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 550 + if component is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 551 + Remove the facet UIComponent associated with the specified name, if there is one. The removed facet will have its parent property cleared. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 552 + if name is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 553 + Remove a Validator instance from the set associated with this UIComponent, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 554 + Set the new value of the attribute with the specified name, replacing any existing value for that name. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + + + + + 555 + if name represents a read-only property of this component + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalArgumentException + + + + + 556 + if name is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 557 + Set the identifier of this UIComponent. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 558 + if componentId is zero length or contains invalid characters + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 559 + if componentId is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 560 + if this UIComponent instance is already in the tree and and is not unique within the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 561 + Set the converter id of the jakarta.faces.convert.Converter that is registered for this component, or null to indicate that there is no registered Converter. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 562 + Set the parent UIComponent of this UIComponent. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 563 + Set the rendered property of this UIComponent. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 564 + Set the Renderer type for this UIComponent, or null for components that render themselves. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 565 + Set the current validity state of this component. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 566 + Update the model data associated with this UIComponent, if any. The default implementation in UIComponentBase does no processing; concrete implementations of components that represent controls that can be altered by users (such as UIInput must provide an apppropriate implementation of this method. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 567 + if context is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 568 + Perform any correctness checks that this component wishes to perform on itself. This method will be called during the Process Validations phase of the request processing lifecycle. If errors are encountered, appropriate Message instances should be added to the FacesContext for the current request, and the valid property of this UIComponent should be set to false. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 569 + if context is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 570 + Evaluate and return the current value of this component, according to the following algorithm. If the value property has been set (containing the local value for this component), return that; else If the valueRef property has been set, Retrieve the Application instance for this web application from ApplicationFactory. Ask it for a ValueBinding for the valueRef expression. Use the getValue() method of the ValueBinding to retrieve the value that the value reference expression points at. Otherwise, return null. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + + + + + 571 + if a problem occurs evaluating the value reference expression + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + EvaluationException + + + + + 572 + if context is null + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 573 + Return the local value of this UIInput component. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIOutput} + + + + + 574 + Return the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIOutput} + + + + + 575 + Set the local value of this UIInput component. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIOutput} + + + java.lang.Object + + + + + + 576 + Set the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UIGraphic.{jakarta.faces.component.UIOutput} + + + java.lang.String + + + + + + 577 + Add a new ValueChangedListener to the set of listeners interested in being notified when ValueChangedEvents occur. + jakarta.faces.component + UIInput + + + jakarta.faces.event.ValueChangedListener + + + + + + 578 + if listener is null + jakarta.faces.component + UIInput + + + jakarta.faces.event.ValueChangedListener + + java.lang.NullPointerException + + + + + 579 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type, for the specified PhaseId. The order in which registered listeners are notified is implementation dependent. After all interested listeners have been notified, return false if this event does not have any listeners interested in this event in future phases of the request processing lifecycle. Otherwise, return true. + jakarta.faces.component + UIInput + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + + + + + 580 + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UIInput + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + jakarta.faces.event.AbortProcessingException + + + + + 581 + if the implementation class of this FacesEvent is not supported by this component + jakarta.faces.component + UIInput + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalArgumentException + + + + + 582 + if PhaseId.ANY_PHASE is passed for the phase identifier + jakarta.faces.component + UIInput + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalStateException + + + + + 583 + if event or phaseId is null + jakarta.faces.component + UIInput + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.NullPointerException + + + + + 584 + Return the component type of this UIComponent. + jakarta.faces.component + UIInput + + + + + 585 + Return the previous value of this UIInput component. This method should only be utilized by the decode() method of this component, or its corresponding jakarta.faces.render.Renderer. + jakarta.faces.component + UIInput + + + + + 586 + Remove an existing ValueChangedListener (if any) from the set of listeners interested in being notified when ValueChangedEvents occur. + jakarta.faces.component + UIInput + + + jakarta.faces.event.ValueChangedListener + + + + + + 587 + if listener is null + jakarta.faces.component + UIInput + + + jakarta.faces.event.ValueChangedListener + + java.lang.NullPointerException + + + + + 588 + Set the previous value of this UIInput component. This method should only be utilized by the decode() method of this component, or its corresponding jakarta.faces.render.Renderer. + jakarta.faces.component + UIInput + + + java.lang.Object + + + + + + 591 + if the valueRef property has invalid syntax for an expression + jakarta.faces.component + UIInput + + + jakarta.faces.context.FacesContext + + java.lang.IllegalArgumentException + + + + + 592 + if context is null + jakarta.faces.component + UIInput + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 594 + if context is null + jakarta.faces.component + UIInput + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 595 + Append the specified UIComponent to the end of the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 596 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 597 + if component is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 598 + Insert the specified UIComponent at the specified position in the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + + + + + 599 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 600 + if the index is out of range ((index < 0) || (index > size())) + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IndexOutOfBoundsException + + + + + 601 + if component is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 602 + Add the specified UIComponent as a facet associated with the name specified by the facetName argument, replacing any previous facet with that name. The newly added facet will have its parent property set to this component. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + 603 + if the either of the facetName or facet arguments are null. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 604 + Add a Validator instance to the set associated with this UIComponent. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 605 + if validator is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + java.lang.NullPointerException + + + + + 606 + Remove all child UIComponents from the child list. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 607 + Remove all facet UIComponents from this component. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 608 + Clear any Validators that have been registered for processing by this component. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 609 + Return true if the specified UIComponent is a direct child of this UIComponent; otherwise, return false. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 610 + if component is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 611 + Decode the current state of this UIComponent from the request contained in the specified FacesContext, and attempt to convert this state information into an object of the required type for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one. If conversion is successful: Save the new local value of this component by calling setValue() and passing the new value. Set the valid property of this component to true. If conversion is not successful: Save state information in such a way that encoding can reproduce the previous input (even though it was syntactically or semantically incorrect) Add an appropriate conversion failure error message by calling context.addMessage(). Set the valid property of this comonent to false. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 612 + if an input/output error occurs during decoding + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 613 + if context is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 614 + Render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. If the conversion attempted in a previous call to decode() for this component failed, the state information saved during execution of decode() should be utilized to reproduce the incorrect input. If the conversion was successful, or if there was no previous call to decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the value as appropriate. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 615 + if an input/output error occurs while rendering + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 616 + if context is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 617 + Render the child UIComponents of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property is true. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 618 + if an input/output error occurs while rendering + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 619 + if context is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 620 + Render the ending of the current state of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 621 + if an input/output error occurs while rendering + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 622 + if context is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 623 + Find the UIComponent named by the specified expression, if any is found. This is done by locating the closest parent UIComponent that is a NamingContainer, and calling its findComponentInNamespace() method. The specified expr may contain either a component identifier, or a set of component identifiers separated by SEPARATOR_CHAR characters. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 624 + if expr is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 625 + Return the value of the attribute with the specified name (if any); otherwise, return null. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 626 + if name is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 627 + Return an Iterator over the names of all currently defined attributes of this UIComponent that have a non-null value. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 628 + Return the UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 629 + if index is out of range ((index = size())) + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 630 + Return the number of UIComponents on the child list for this component. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 631 + Return an Iterator over the child UIComponents of this UIComponent, in the order of their position in the child list. If this component has no children, an empty Iterator is returned. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 632 + Return a client-side identifier for this component, generating one if necessary. Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 633 + if context is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 634 + Return the identifier of this UIComponent. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 635 + Return the component type of this UIComponent. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 636 + Return the converter id of the jakarta.faces.convert.Converter that is registered for this component. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 637 + Return the facet UIComponent associated with the specified name, if any. Otherwise, return null. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 638 + if name is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 639 + Return an Iterator over the names of the facet UIComponents of this UIComponent. If this component has no facets, an empty Iterator is returned. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 640 + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 641 + Return the parent UIComponent of this UIComponent, if any. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 642 + Return the Renderer type for this UIComponent (if any). + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 643 + Return a flag indicating whether this component is responsible for rendering its child components. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 644 + Return a flag indicating whether this component has concrete implementations of the decode() and encodeXxx() methods, and is therefore suitable for use in the direct implementation programming model for rendering. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 645 + Return an Iterator over the Validators associated with this UIComponent. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 646 + Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 647 + Return the current validity state of this component. The validity state of a component is adjusted at the following points during the request processing lifecycle: During the Apply Request Values phase, set to true or false by decode(), based on the success or failure of decoding a new local value for this component. During the Process Validations phase, set to false by processValidations() if any call to a validate() method returned false. During the Update Model Values phase, set to false by updateModel() if any conversion or update error occurred. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + + + 648 + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 649 + if an input/output error occurs during decoding + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 650 + if context is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 651 + Perform the component tree processing required by the Reconstitute Component Tree phase of the request processing lifecyc,e for all facets of this component, all children of this component, and this component itself, as follows. Call the processReconstitutes() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). Call the reconstitute() method of this component. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 652 + if an input/output error occurs during processing + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 653 + if context is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 654 + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the updateModel() method of this component. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 655 + if context is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 656 + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property of this component is currently true: Call the validate() method of each Validator registered for this UIComponent. Call the validate() method of this component. Set the valid property of this component to the result returned from the validate() method. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 657 + if context is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 658 + Perform any processing required to correct the state of this component as a result of the owning component tree having been reconstructed during Reconstitute Component Tree phase of the request processing lifecycle. The default implementation of this method does nothing. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 659 + if an input/output error occurs during processing + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 660 + if context is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 661 + Remove the child UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 662 + if the index is out of range ((index < 0) || (index >= size())) + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 663 + Remove the child UIComponent from the child list for this component. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 664 + if component is not a child of this component + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 665 + if component is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 666 + Remove the facet UIComponent associated with the specified name, if there is one. The removed facet will have its parent property cleared. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 667 + if name is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 668 + Remove a Validator instance from the set associated with this UIComponent, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 669 + Set the new value of the attribute with the specified name, replacing any existing value for that name. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + + + + + 670 + if name represents a read-only property of this component + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalArgumentException + + + + + 671 + if name is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 672 + Set the identifier of this UIComponent. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 673 + if componentId is zero length or contains invalid characters + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 674 + if componentId is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 675 + if this UIComponent instance is already in the tree and and is not unique within the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 676 + Set the converter id of the jakarta.faces.convert.Converter that is registered for this component, or null to indicate that there is no registered Converter. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 677 + Set the parent UIComponent of this UIComponent. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 678 + Set the rendered property of this UIComponent. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 679 + Set the Renderer type for this UIComponent, or null for components that render themselves. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 680 + Set the current validity state of this component. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 681 + Evaluate and return the current value of this component, according to the following algorithm. If the value property has been set (containing the local value for this component), return that; else If the valueRef property has been set, Retrieve the Application instance for this web application from ApplicationFactory. Ask it for a ValueBinding for the valueRef expression. Use the getValue() method of the ValueBinding to retrieve the value that the value reference expression points at. Otherwise, return null. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + + + + + 682 + if a problem occurs evaluating the value reference expression + jakarta.faces.component + UIInput.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + EvaluationException + + + + + 683 + if context is null + jakarta.faces.component + UIInput.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 684 + Return the local value of this UIInput component. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIOutput} + + + + + 685 + Return the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIOutput} + + + + + 686 + Set the local value of this UIInput component. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIOutput} + + + java.lang.Object + + + + + + 687 + Set the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UIInput.{jakarta.faces.component.UIOutput} + + + java.lang.String + + + + + + 688 + Add the specified UIComponent to the namespace of this naming container. + jakarta.faces.component + UINamingContainer + + + jakarta.faces.component.UIComponent + + + + + + 689 + if the specified component does not have a componentId + jakarta.faces.component + UINamingContainer + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 690 + if the component identifier of the specified component is not unique within the namespace of this naming container + jakarta.faces.component + UINamingContainer + + + jakarta.faces.component.UIComponent + + java.lang.IllegalStateException + + + + + 691 + if component is null + jakarta.faces.component + UINamingContainer + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 692 + Find and return a UIComponent in this namespace, if it is present; otherwise return null. If the argument name does not contain any UIComponent#SEPARATOR_CHAR characters, it is interpreted to be a name in the namespace of this naming container. If the argument name does contain UIComponent#SEPARATOR_CHAR characters, each segment between UIComponent#SEPARATOR_CHAR is treated as a component identifier in its own namespace, which are searched for in child naming containers of this naming container, from left to right. + jakarta.faces.component + UINamingContainer + + + java.lang.String + + + + + + 693 + if name is malformed + jakarta.faces.component + UINamingContainer + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 694 + if name is null + jakarta.faces.component + UINamingContainer + + + java.lang.String + + java.lang.NullPointerException + + + + + 695 + Generate an identifier for a component, suitable for communication to a client. The identifier returned from this method must be unique within this namespace. + jakarta.faces.component + UINamingContainer + + + + + 696 + Return the component type of this UIComponent. + jakarta.faces.component + UINamingContainer + + + + + 697 + Remove the specified UIComponent from the namespace of this naming container, if it is present. + jakarta.faces.component + UINamingContainer + + + jakarta.faces.component.UIComponent + + + + + + 698 + if the specified component does not have a componentId + jakarta.faces.component + UINamingContainer + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 699 + if component is null + jakarta.faces.component + UINamingContainer + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 701 + Append the specified UIComponent to the end of the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 702 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 703 + if component is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 704 + Insert the specified UIComponent at the specified position in the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + + + + + 705 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 706 + if the index is out of range ((index < 0) || (index > size())) + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IndexOutOfBoundsException + + + + + 707 + if component is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 708 + Add the specified UIComponent as a facet associated with the name specified by the facetName argument, replacing any previous facet with that name. The newly added facet will have its parent property set to this component. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + 709 + if the either of the facetName or facet arguments are null. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 710 + Add a Validator instance to the set associated with this UIComponent. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 711 + if validator is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + java.lang.NullPointerException + + + + + 712 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type, for the specified PhaseId (or for any phase, if the listener returns PhaseId.ANY_PHASE from its getPhaseId() method. The order in which registered listeners are notified is implementation dependent. After all interested listeners have been notified, return false if this event does not have any listeners interested in this event in future phases of the request processing lifecycle. Otherwise, return true. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + + + + + 713 + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + jakarta.faces.event.AbortProcessingException + + + + + 714 + if the implementation class of this FacesEvent is not supported by this component + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalArgumentException + + + + + 715 + if PhaseId.ANY_PHASE is passed for the phase identifier + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalStateException + + + + + 716 + if event or phaseId is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.NullPointerException + + + + + 717 + Remove all child UIComponents from the child list. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 718 + Remove all facet UIComponents from this component. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 719 + Clear any Validators that have been registered for processing by this component. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 720 + Return true if the specified UIComponent is a direct child of this UIComponent; otherwise, return false. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 721 + if component is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 722 + Decode the current state of this UIComponent from the request contained in the specified FacesContext, and attempt to convert this state information into an object of the required type for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one. If conversion is successful: Save the new local value of this component by calling setValue() and passing the new value. Set the valid property of this component to true. If conversion is not successful: Save state information in such a way that encoding can reproduce the previous input (even though it was syntactically or semantically incorrect) Add an appropriate conversion failure error message by calling context.addMessage(). Set the valid property of this comonent to false. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 723 + if an input/output error occurs during decoding + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 724 + if context is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 725 + Render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. If the conversion attempted in a previous call to decode() for this component failed, the state information saved during execution of decode() should be utilized to reproduce the incorrect input. If the conversion was successful, or if there was no previous call to decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the value as appropriate. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 726 + if an input/output error occurs while rendering + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 727 + if context is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 728 + Render the child UIComponents of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property is true. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 729 + if an input/output error occurs while rendering + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 730 + if context is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 731 + Render the ending of the current state of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 732 + if an input/output error occurs while rendering + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 733 + if context is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 734 + Find the UIComponent named by the specified expression, if any is found. This is done by locating the closest parent UIComponent that is a NamingContainer, and calling its findComponentInNamespace() method. The specified expr may contain either a component identifier, or a set of component identifiers separated by SEPARATOR_CHAR characters. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 735 + if expr is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 736 + Return the value of the attribute with the specified name (if any); otherwise, return null. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 737 + if name is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 738 + Return an Iterator over the names of all currently defined attributes of this UIComponent that have a non-null value. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 739 + Return the UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 740 + if index is out of range ((index = size())) + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 741 + Return the number of UIComponents on the child list for this component. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 742 + Return an Iterator over the child UIComponents of this UIComponent, in the order of their position in the child list. If this component has no children, an empty Iterator is returned. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 743 + Return a client-side identifier for this component, generating one if necessary. Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 744 + if context is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 745 + Return the identifier of this UIComponent. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 746 + Return the converter id of the jakarta.faces.convert.Converter that is registered for this component. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 747 + Return the facet UIComponent associated with the specified name, if any. Otherwise, return null. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 748 + if name is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 749 + Return an Iterator over the names of the facet UIComponents of this UIComponent. If this component has no facets, an empty Iterator is returned. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 750 + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 751 + Return the parent UIComponent of this UIComponent, if any. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 752 + Return the Renderer type for this UIComponent (if any). + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 753 + Return a flag indicating whether this component is responsible for rendering its child components. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 754 + Return a flag indicating whether this component has concrete implementations of the decode() and encodeXxx() methods, and is therefore suitable for use in the direct implementation programming model for rendering. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 755 + Return an Iterator over the Validators associated with this UIComponent. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 756 + Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 757 + Return the current validity state of this component. The validity state of a component is adjusted at the following points during the request processing lifecycle: During the Apply Request Values phase, set to true or false by decode(), based on the success or failure of decoding a new local value for this component. During the Process Validations phase, set to false by processValidations() if any call to a validate() method returned false. During the Update Model Values phase, set to false by updateModel() if any conversion or update error occurred. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + + + 758 + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 759 + if an input/output error occurs during decoding + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 760 + if context is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 761 + Perform the component tree processing required by the Reconstitute Component Tree phase of the request processing lifecyc,e for all facets of this component, all children of this component, and this component itself, as follows. Call the processReconstitutes() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). Call the reconstitute() method of this component. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 762 + if an input/output error occurs during processing + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 763 + if context is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 764 + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the updateModel() method of this component. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 765 + if context is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 766 + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property of this component is currently true: Call the validate() method of each Validator registered for this UIComponent. Call the validate() method of this component. Set the valid property of this component to the result returned from the validate() method. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 767 + if context is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 768 + Perform any processing required to correct the state of this component as a result of the owning component tree having been reconstructed during Reconstitute Component Tree phase of the request processing lifecycle. The default implementation of this method does nothing. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 769 + if an input/output error occurs during processing + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 770 + if context is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 771 + Remove the child UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 772 + if the index is out of range ((index < 0) || (index >= size())) + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 773 + Remove the child UIComponent from the child list for this component. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 774 + if component is not a child of this component + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 775 + if component is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 776 + Remove the facet UIComponent associated with the specified name, if there is one. The removed facet will have its parent property cleared. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 777 + if name is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 778 + Remove a Validator instance from the set associated with this UIComponent, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 779 + Set the new value of the attribute with the specified name, replacing any existing value for that name. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + + + + + 780 + if name represents a read-only property of this component + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalArgumentException + + + + + 781 + if name is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 782 + Set the identifier of this UIComponent. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 783 + if componentId is zero length or contains invalid characters + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 784 + if componentId is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 785 + if this UIComponent instance is already in the tree and and is not unique within the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 786 + Set the converter id of the jakarta.faces.convert.Converter that is registered for this component, or null to indicate that there is no registered Converter. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 787 + Set the parent UIComponent of this UIComponent. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 788 + Set the rendered property of this UIComponent. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 789 + Set the Renderer type for this UIComponent, or null for components that render themselves. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 790 + Set the current validity state of this component. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 791 + Update the model data associated with this UIComponent, if any. The default implementation in UIComponentBase does no processing; concrete implementations of components that represent controls that can be altered by users (such as UIInput must provide an apppropriate implementation of this method. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 792 + if context is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 793 + Perform any correctness checks that this component wishes to perform on itself. This method will be called during the Process Validations phase of the request processing lifecycle. If errors are encountered, appropriate Message instances should be added to the FacesContext for the current request, and the valid property of this UIComponent should be set to false. + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 794 + if context is null + jakarta.faces.component + UINamingContainer.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 795 + Evaluate and return the current value of this component, according to the following algorithm. If the value property has been set (containing the local value for this component), return that; else If the valueRef property has been set, Retrieve the Application instance for this web application from ApplicationFactory. Ask it for a ValueBinding for the valueRef expression. Use the getValue() method of the ValueBinding to retrieve the value that the value reference expression points at. Otherwise, return null. + jakarta.faces.component + UIOutput + + + jakarta.faces.context.FacesContext + + + + + + 796 + if a problem occurs evaluating the value reference expression + jakarta.faces.component + UIOutput + + + jakarta.faces.context.FacesContext + + EvaluationException + + + + + 797 + if context is null + jakarta.faces.component + UIOutput + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 798 + Return the component type of this UIComponent. + jakarta.faces.component + UIOutput + + + + + 800 + Return the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UIOutput + + + + + 802 + Set the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UIOutput + + + java.lang.String + + + + + + 804 + Append the specified UIComponent to the end of the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 805 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 806 + if component is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 807 + Insert the specified UIComponent at the specified position in the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + + + + + 808 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 809 + if the index is out of range ((index < 0) || (index > size())) + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IndexOutOfBoundsException + + + + + 810 + if component is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 811 + Add the specified UIComponent as a facet associated with the name specified by the facetName argument, replacing any previous facet with that name. The newly added facet will have its parent property set to this component. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + 812 + if the either of the facetName or facet arguments are null. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 813 + Add a Validator instance to the set associated with this UIComponent. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 814 + if validator is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + java.lang.NullPointerException + + + + + 815 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type, for the specified PhaseId (or for any phase, if the listener returns PhaseId.ANY_PHASE from its getPhaseId() method. The order in which registered listeners are notified is implementation dependent. After all interested listeners have been notified, return false if this event does not have any listeners interested in this event in future phases of the request processing lifecycle. Otherwise, return true. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + + + + + 816 + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + jakarta.faces.event.AbortProcessingException + + + + + 817 + if the implementation class of this FacesEvent is not supported by this component + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalArgumentException + + + + + 818 + if PhaseId.ANY_PHASE is passed for the phase identifier + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalStateException + + + + + 819 + if event or phaseId is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.NullPointerException + + + + + 820 + Remove all child UIComponents from the child list. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 821 + Remove all facet UIComponents from this component. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 822 + Clear any Validators that have been registered for processing by this component. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 823 + Return true if the specified UIComponent is a direct child of this UIComponent; otherwise, return false. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 824 + if component is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 825 + Decode the current state of this UIComponent from the request contained in the specified FacesContext, and attempt to convert this state information into an object of the required type for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one. If conversion is successful: Save the new local value of this component by calling setValue() and passing the new value. Set the valid property of this component to true. If conversion is not successful: Save state information in such a way that encoding can reproduce the previous input (even though it was syntactically or semantically incorrect) Add an appropriate conversion failure error message by calling context.addMessage(). Set the valid property of this comonent to false. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 826 + if an input/output error occurs during decoding + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 827 + if context is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 828 + Render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. If the conversion attempted in a previous call to decode() for this component failed, the state information saved during execution of decode() should be utilized to reproduce the incorrect input. If the conversion was successful, or if there was no previous call to decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the value as appropriate. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 829 + if an input/output error occurs while rendering + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 830 + if context is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 831 + Render the child UIComponents of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property is true. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 832 + if an input/output error occurs while rendering + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 833 + if context is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 834 + Render the ending of the current state of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 835 + if an input/output error occurs while rendering + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 836 + if context is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 837 + Find the UIComponent named by the specified expression, if any is found. This is done by locating the closest parent UIComponent that is a NamingContainer, and calling its findComponentInNamespace() method. The specified expr may contain either a component identifier, or a set of component identifiers separated by SEPARATOR_CHAR characters. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 838 + if expr is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 839 + Return the value of the attribute with the specified name (if any); otherwise, return null. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 840 + if name is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 841 + Return an Iterator over the names of all currently defined attributes of this UIComponent that have a non-null value. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 842 + Return the UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 843 + if index is out of range ((index = size())) + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 844 + Return the number of UIComponents on the child list for this component. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 845 + Return an Iterator over the child UIComponents of this UIComponent, in the order of their position in the child list. If this component has no children, an empty Iterator is returned. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 846 + Return a client-side identifier for this component, generating one if necessary. Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 847 + if context is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 848 + Return the identifier of this UIComponent. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 849 + Return the converter id of the jakarta.faces.convert.Converter that is registered for this component. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 850 + Return the facet UIComponent associated with the specified name, if any. Otherwise, return null. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 851 + if name is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 852 + Return an Iterator over the names of the facet UIComponents of this UIComponent. If this component has no facets, an empty Iterator is returned. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 853 + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 854 + Return the parent UIComponent of this UIComponent, if any. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 855 + Return the Renderer type for this UIComponent (if any). + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 856 + Return a flag indicating whether this component is responsible for rendering its child components. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 857 + Return a flag indicating whether this component has concrete implementations of the decode() and encodeXxx() methods, and is therefore suitable for use in the direct implementation programming model for rendering. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 858 + Return an Iterator over the Validators associated with this UIComponent. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 859 + Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 860 + Return the current validity state of this component. The validity state of a component is adjusted at the following points during the request processing lifecycle: During the Apply Request Values phase, set to true or false by decode(), based on the success or failure of decoding a new local value for this component. During the Process Validations phase, set to false by processValidations() if any call to a validate() method returned false. During the Update Model Values phase, set to false by updateModel() if any conversion or update error occurred. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + + + 861 + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 862 + if an input/output error occurs during decoding + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 863 + if context is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 864 + Perform the component tree processing required by the Reconstitute Component Tree phase of the request processing lifecyc,e for all facets of this component, all children of this component, and this component itself, as follows. Call the processReconstitutes() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). Call the reconstitute() method of this component. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 865 + if an input/output error occurs during processing + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 866 + if context is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 867 + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the updateModel() method of this component. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 868 + if context is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 869 + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property of this component is currently true: Call the validate() method of each Validator registered for this UIComponent. Call the validate() method of this component. Set the valid property of this component to the result returned from the validate() method. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 870 + if context is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 871 + Perform any processing required to correct the state of this component as a result of the owning component tree having been reconstructed during Reconstitute Component Tree phase of the request processing lifecycle. The default implementation of this method does nothing. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 872 + if an input/output error occurs during processing + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 873 + if context is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 874 + Remove the child UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 875 + if the index is out of range ((index < 0) || (index >= size())) + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 876 + Remove the child UIComponent from the child list for this component. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 877 + if component is not a child of this component + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 878 + if component is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 879 + Remove the facet UIComponent associated with the specified name, if there is one. The removed facet will have its parent property cleared. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 880 + if name is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 881 + Remove a Validator instance from the set associated with this UIComponent, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 882 + Set the new value of the attribute with the specified name, replacing any existing value for that name. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + + + + + 883 + if name represents a read-only property of this component + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalArgumentException + + + + + 884 + if name is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 885 + Set the identifier of this UIComponent. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 886 + if componentId is zero length or contains invalid characters + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 887 + if componentId is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 888 + if this UIComponent instance is already in the tree and and is not unique within the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 889 + Set the converter id of the jakarta.faces.convert.Converter that is registered for this component, or null to indicate that there is no registered Converter. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 890 + Set the parent UIComponent of this UIComponent. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 891 + Set the rendered property of this UIComponent. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 892 + Set the Renderer type for this UIComponent, or null for components that render themselves. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 893 + Set the current validity state of this component. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 894 + Update the model data associated with this UIComponent, if any. The default implementation in UIComponentBase does no processing; concrete implementations of components that represent controls that can be altered by users (such as UIInput must provide an apppropriate implementation of this method. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 895 + if context is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 896 + Perform any correctness checks that this component wishes to perform on itself. This method will be called during the Process Validations phase of the request processing lifecycle. If errors are encountered, appropriate Message instances should be added to the FacesContext for the current request, and the valid property of this UIComponent should be set to false. + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 897 + if context is null + jakarta.faces.component + UIOutput.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 898 + Return the component type of this UIComponent. + jakarta.faces.component + UIPanel + + + + + 899 + Return true to indicate that this component takes responsibility for rendering its children. + jakarta.faces.component + UIPanel + + + + + 901 + Append the specified UIComponent to the end of the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 902 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 903 + if component is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 904 + Insert the specified UIComponent at the specified position in the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + + + + + 905 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 906 + if the index is out of range ((index < 0) || (index > size())) + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IndexOutOfBoundsException + + + + + 907 + if component is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 908 + Add the specified UIComponent as a facet associated with the name specified by the facetName argument, replacing any previous facet with that name. The newly added facet will have its parent property set to this component. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + 909 + if the either of the facetName or facet arguments are null. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 910 + Add a Validator instance to the set associated with this UIComponent. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 911 + if validator is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + java.lang.NullPointerException + + + + + 912 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type, for the specified PhaseId (or for any phase, if the listener returns PhaseId.ANY_PHASE from its getPhaseId() method. The order in which registered listeners are notified is implementation dependent. After all interested listeners have been notified, return false if this event does not have any listeners interested in this event in future phases of the request processing lifecycle. Otherwise, return true. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + + + + + 913 + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + jakarta.faces.event.AbortProcessingException + + + + + 914 + if the implementation class of this FacesEvent is not supported by this component + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalArgumentException + + + + + 915 + if PhaseId.ANY_PHASE is passed for the phase identifier + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalStateException + + + + + 916 + if event or phaseId is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.NullPointerException + + + + + 917 + Remove all child UIComponents from the child list. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 918 + Remove all facet UIComponents from this component. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 919 + Clear any Validators that have been registered for processing by this component. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 920 + Return true if the specified UIComponent is a direct child of this UIComponent; otherwise, return false. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 921 + if component is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 922 + Decode the current state of this UIComponent from the request contained in the specified FacesContext, and attempt to convert this state information into an object of the required type for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one. If conversion is successful: Save the new local value of this component by calling setValue() and passing the new value. Set the valid property of this component to true. If conversion is not successful: Save state information in such a way that encoding can reproduce the previous input (even though it was syntactically or semantically incorrect) Add an appropriate conversion failure error message by calling context.addMessage(). Set the valid property of this comonent to false. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 923 + if an input/output error occurs during decoding + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 924 + if context is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 925 + Render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. If the conversion attempted in a previous call to decode() for this component failed, the state information saved during execution of decode() should be utilized to reproduce the incorrect input. If the conversion was successful, or if there was no previous call to decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the value as appropriate. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 926 + if an input/output error occurs while rendering + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 927 + if context is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 928 + Render the child UIComponents of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property is true. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 929 + if an input/output error occurs while rendering + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 930 + if context is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 931 + Render the ending of the current state of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 932 + if an input/output error occurs while rendering + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 933 + if context is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 934 + Find the UIComponent named by the specified expression, if any is found. This is done by locating the closest parent UIComponent that is a NamingContainer, and calling its findComponentInNamespace() method. The specified expr may contain either a component identifier, or a set of component identifiers separated by SEPARATOR_CHAR characters. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 935 + if expr is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 936 + Return the value of the attribute with the specified name (if any); otherwise, return null. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 937 + if name is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 938 + Return an Iterator over the names of all currently defined attributes of this UIComponent that have a non-null value. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 939 + Return the UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 940 + if index is out of range ((index = size())) + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 941 + Return the number of UIComponents on the child list for this component. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 942 + Return an Iterator over the child UIComponents of this UIComponent, in the order of their position in the child list. If this component has no children, an empty Iterator is returned. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 943 + Return a client-side identifier for this component, generating one if necessary. Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 944 + if context is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 945 + Return the identifier of this UIComponent. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 946 + Return the component type of this UIComponent. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 947 + Return the converter id of the jakarta.faces.convert.Converter that is registered for this component. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 948 + Return the facet UIComponent associated with the specified name, if any. Otherwise, return null. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 949 + if name is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 950 + Return an Iterator over the names of the facet UIComponents of this UIComponent. If this component has no facets, an empty Iterator is returned. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 951 + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 952 + Return the parent UIComponent of this UIComponent, if any. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 953 + Return the Renderer type for this UIComponent (if any). + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 954 + Return a flag indicating whether this component has concrete implementations of the decode() and encodeXxx() methods, and is therefore suitable for use in the direct implementation programming model for rendering. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 955 + Return an Iterator over the Validators associated with this UIComponent. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 956 + Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 957 + Return the current validity state of this component. The validity state of a component is adjusted at the following points during the request processing lifecycle: During the Apply Request Values phase, set to true or false by decode(), based on the success or failure of decoding a new local value for this component. During the Process Validations phase, set to false by processValidations() if any call to a validate() method returned false. During the Update Model Values phase, set to false by updateModel() if any conversion or update error occurred. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + + + 958 + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 959 + if an input/output error occurs during decoding + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 960 + if context is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 961 + Perform the component tree processing required by the Reconstitute Component Tree phase of the request processing lifecyc,e for all facets of this component, all children of this component, and this component itself, as follows. Call the processReconstitutes() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). Call the reconstitute() method of this component. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 962 + if an input/output error occurs during processing + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 963 + if context is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 964 + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the updateModel() method of this component. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 965 + if context is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 966 + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property of this component is currently true: Call the validate() method of each Validator registered for this UIComponent. Call the validate() method of this component. Set the valid property of this component to the result returned from the validate() method. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 967 + if context is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 968 + Perform any processing required to correct the state of this component as a result of the owning component tree having been reconstructed during Reconstitute Component Tree phase of the request processing lifecycle. The default implementation of this method does nothing. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 969 + if an input/output error occurs during processing + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 970 + if context is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 971 + Remove the child UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 972 + if the index is out of range ((index < 0) || (index >= size())) + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 973 + Remove the child UIComponent from the child list for this component. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 974 + if component is not a child of this component + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 975 + if component is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 976 + Remove the facet UIComponent associated with the specified name, if there is one. The removed facet will have its parent property cleared. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 977 + if name is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 978 + Remove a Validator instance from the set associated with this UIComponent, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 979 + Set the new value of the attribute with the specified name, replacing any existing value for that name. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + + + + + 980 + if name represents a read-only property of this component + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalArgumentException + + + + + 981 + if name is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 982 + Set the identifier of this UIComponent. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 983 + if componentId is zero length or contains invalid characters + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 984 + if componentId is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 985 + if this UIComponent instance is already in the tree and and is not unique within the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 986 + Set the converter id of the jakarta.faces.convert.Converter that is registered for this component, or null to indicate that there is no registered Converter. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 987 + Set the parent UIComponent of this UIComponent. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 988 + Set the rendered property of this UIComponent. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 989 + Set the Renderer type for this UIComponent, or null for components that render themselves. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 990 + Set the current validity state of this component. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 991 + Update the model data associated with this UIComponent, if any. The default implementation in UIComponentBase does no processing; concrete implementations of components that represent controls that can be altered by users (such as UIInput must provide an apppropriate implementation of this method. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 992 + if context is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 993 + Perform any correctness checks that this component wishes to perform on itself. This method will be called during the Process Validations phase of the request processing lifecycle. If errors are encountered, appropriate Message instances should be added to the FacesContext for the current request, and the valid property of this UIComponent should be set to false. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 994 + if context is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 995 + Evaluate and return the current value of this component, according to the following algorithm. If the value property has been set (containing the local value for this component), return that; else If the valueRef property has been set, Retrieve the Application instance for this web application from ApplicationFactory. Ask it for a ValueBinding for the valueRef expression. Use the getValue() method of the ValueBinding to retrieve the value that the value reference expression points at. Otherwise, return null. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + + + + + 996 + if a problem occurs evaluating the value reference expression + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + EvaluationException + + + + + 997 + if context is null + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 998 + Return the local value of this UIInput component. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIOutput} + + + + + 999 + Return the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIOutput} + + + + + 1000 + Set the local value of this UIInput component. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIOutput} + + + java.lang.Object + + + + + + 1001 + Set the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UIPanel.{jakarta.faces.component.UIOutput} + + + java.lang.String + + + + + + 1002 + Return the component type of this UIComponent. + jakarta.faces.component + UIParameter + + + + + 1004 + Return true to indicate that no jakarta.faces.render.Renderer needs to be associated with this component. + jakarta.faces.component + UIParameter + + + + + 1007 + Append the specified UIComponent to the end of the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1008 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1009 + if component is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1010 + Insert the specified UIComponent at the specified position in the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + + + + + 1011 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1012 + if the index is out of range ((index < 0) || (index > size())) + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IndexOutOfBoundsException + + + + + 1013 + if component is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1014 + Add the specified UIComponent as a facet associated with the name specified by the facetName argument, replacing any previous facet with that name. The newly added facet will have its parent property set to this component. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + 1015 + if the either of the facetName or facet arguments are null. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1016 + Add a Validator instance to the set associated with this UIComponent. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 1017 + if validator is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + java.lang.NullPointerException + + + + + 1018 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type, for the specified PhaseId (or for any phase, if the listener returns PhaseId.ANY_PHASE from its getPhaseId() method. The order in which registered listeners are notified is implementation dependent. After all interested listeners have been notified, return false if this event does not have any listeners interested in this event in future phases of the request processing lifecycle. Otherwise, return true. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + + + + + 1019 + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + jakarta.faces.event.AbortProcessingException + + + + + 1020 + if the implementation class of this FacesEvent is not supported by this component + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalArgumentException + + + + + 1021 + if PhaseId.ANY_PHASE is passed for the phase identifier + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalStateException + + + + + 1022 + if event or phaseId is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.NullPointerException + + + + + 1023 + Remove all child UIComponents from the child list. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1024 + Remove all facet UIComponents from this component. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1025 + Clear any Validators that have been registered for processing by this component. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1026 + Return true if the specified UIComponent is a direct child of this UIComponent; otherwise, return false. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1027 + if component is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1028 + Decode the current state of this UIComponent from the request contained in the specified FacesContext, and attempt to convert this state information into an object of the required type for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one. If conversion is successful: Save the new local value of this component by calling setValue() and passing the new value. Set the valid property of this component to true. If conversion is not successful: Save state information in such a way that encoding can reproduce the previous input (even though it was syntactically or semantically incorrect) Add an appropriate conversion failure error message by calling context.addMessage(). Set the valid property of this comonent to false. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1029 + if an input/output error occurs during decoding + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1030 + if context is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1031 + Render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. If the conversion attempted in a previous call to decode() for this component failed, the state information saved during execution of decode() should be utilized to reproduce the incorrect input. If the conversion was successful, or if there was no previous call to decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the value as appropriate. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1032 + if an input/output error occurs while rendering + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1033 + if context is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1034 + Render the child UIComponents of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property is true. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1035 + if an input/output error occurs while rendering + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1036 + if context is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1037 + Render the ending of the current state of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1038 + if an input/output error occurs while rendering + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1039 + if context is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1040 + Find the UIComponent named by the specified expression, if any is found. This is done by locating the closest parent UIComponent that is a NamingContainer, and calling its findComponentInNamespace() method. The specified expr may contain either a component identifier, or a set of component identifiers separated by SEPARATOR_CHAR characters. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1041 + if expr is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1042 + Return the value of the attribute with the specified name (if any); otherwise, return null. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1043 + if name is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1044 + Return an Iterator over the names of all currently defined attributes of this UIComponent that have a non-null value. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1045 + Return the UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 1046 + if index is out of range ((index = size())) + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 1047 + Return the number of UIComponents on the child list for this component. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1048 + Return an Iterator over the child UIComponents of this UIComponent, in the order of their position in the child list. If this component has no children, an empty Iterator is returned. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1049 + Return a client-side identifier for this component, generating one if necessary. Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1050 + if context is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1051 + Return the identifier of this UIComponent. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1052 + Return the component type of this UIComponent. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1053 + Return the converter id of the jakarta.faces.convert.Converter that is registered for this component. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1054 + Return the facet UIComponent associated with the specified name, if any. Otherwise, return null. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1055 + if name is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1056 + Return an Iterator over the names of the facet UIComponents of this UIComponent. If this component has no facets, an empty Iterator is returned. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1057 + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1058 + Return the parent UIComponent of this UIComponent, if any. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1059 + Return the Renderer type for this UIComponent (if any). + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1060 + Return a flag indicating whether this component is responsible for rendering its child components. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1061 + Return an Iterator over the Validators associated with this UIComponent. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1062 + Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1063 + Return the current validity state of this component. The validity state of a component is adjusted at the following points during the request processing lifecycle: During the Apply Request Values phase, set to true or false by decode(), based on the success or failure of decoding a new local value for this component. During the Process Validations phase, set to false by processValidations() if any call to a validate() method returned false. During the Update Model Values phase, set to false by updateModel() if any conversion or update error occurred. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + + + 1064 + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1065 + if an input/output error occurs during decoding + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1066 + if context is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1067 + Perform the component tree processing required by the Reconstitute Component Tree phase of the request processing lifecyc,e for all facets of this component, all children of this component, and this component itself, as follows. Call the processReconstitutes() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). Call the reconstitute() method of this component. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1068 + if an input/output error occurs during processing + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1069 + if context is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1070 + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the updateModel() method of this component. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1071 + if context is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1072 + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property of this component is currently true: Call the validate() method of each Validator registered for this UIComponent. Call the validate() method of this component. Set the valid property of this component to the result returned from the validate() method. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1073 + if context is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1074 + Perform any processing required to correct the state of this component as a result of the owning component tree having been reconstructed during Reconstitute Component Tree phase of the request processing lifecycle. The default implementation of this method does nothing. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1075 + if an input/output error occurs during processing + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1076 + if context is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1077 + Remove the child UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 1078 + if the index is out of range ((index < 0) || (index >= size())) + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 1079 + Remove the child UIComponent from the child list for this component. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1080 + if component is not a child of this component + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1081 + if component is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1082 + Remove the facet UIComponent associated with the specified name, if there is one. The removed facet will have its parent property cleared. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1083 + if name is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1084 + Remove a Validator instance from the set associated with this UIComponent, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 1085 + Set the new value of the attribute with the specified name, replacing any existing value for that name. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + + + + + 1086 + if name represents a read-only property of this component + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalArgumentException + + + + + 1087 + if name is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 1088 + Set the identifier of this UIComponent. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1089 + if componentId is zero length or contains invalid characters + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1090 + if componentId is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1091 + if this UIComponent instance is already in the tree and and is not unique within the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1092 + Set the converter id of the jakarta.faces.convert.Converter that is registered for this component, or null to indicate that there is no registered Converter. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1093 + Set the parent UIComponent of this UIComponent. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1094 + Set the rendered property of this UIComponent. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 1095 + Set the Renderer type for this UIComponent, or null for components that render themselves. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1096 + Set the current validity state of this component. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 1097 + Update the model data associated with this UIComponent, if any. The default implementation in UIComponentBase does no processing; concrete implementations of components that represent controls that can be altered by users (such as UIInput must provide an apppropriate implementation of this method. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1098 + if context is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1099 + Perform any correctness checks that this component wishes to perform on itself. This method will be called during the Process Validations phase of the request processing lifecycle. If errors are encountered, appropriate Message instances should be added to the FacesContext for the current request, and the valid property of this UIComponent should be set to false. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1100 + if context is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1101 + Evaluate and return the current value of this component, according to the following algorithm. If the value property has been set (containing the local value for this component), return that; else If the valueRef property has been set, Retrieve the Application instance for this web application from ApplicationFactory. Ask it for a ValueBinding for the valueRef expression. Use the getValue() method of the ValueBinding to retrieve the value that the value reference expression points at. Otherwise, return null. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + + + + + 1102 + if a problem occurs evaluating the value reference expression + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + EvaluationException + + + + + 1103 + if context is null + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1104 + Return the local value of this UIInput component. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIOutput} + + + + + 1105 + Return the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIOutput} + + + + + 1106 + Set the local value of this UIInput component. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIOutput} + + + java.lang.Object + + + + + + 1107 + Set the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UIParameter.{jakarta.faces.component.UIOutput} + + + java.lang.String + + + + + + 1108 + Return the component type of this UIComponent. + jakarta.faces.component + UISelectBoolean + + + + + 1112 + Append the specified UIComponent to the end of the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1113 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1114 + if component is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1115 + Insert the specified UIComponent at the specified position in the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + + + + + 1116 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1117 + if the index is out of range ((index < 0) || (index > size())) + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IndexOutOfBoundsException + + + + + 1118 + if component is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1119 + Add the specified UIComponent as a facet associated with the name specified by the facetName argument, replacing any previous facet with that name. The newly added facet will have its parent property set to this component. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + 1120 + if the either of the facetName or facet arguments are null. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1121 + Add a Validator instance to the set associated with this UIComponent. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 1122 + if validator is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + java.lang.NullPointerException + + + + + 1123 + Remove all child UIComponents from the child list. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1124 + Remove all facet UIComponents from this component. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1125 + Clear any Validators that have been registered for processing by this component. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1126 + Return true if the specified UIComponent is a direct child of this UIComponent; otherwise, return false. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1127 + if component is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1128 + Decode the current state of this UIComponent from the request contained in the specified FacesContext, and attempt to convert this state information into an object of the required type for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one. If conversion is successful: Save the new local value of this component by calling setValue() and passing the new value. Set the valid property of this component to true. If conversion is not successful: Save state information in such a way that encoding can reproduce the previous input (even though it was syntactically or semantically incorrect) Add an appropriate conversion failure error message by calling context.addMessage(). Set the valid property of this comonent to false. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1129 + if an input/output error occurs during decoding + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1130 + if context is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1131 + Render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. If the conversion attempted in a previous call to decode() for this component failed, the state information saved during execution of decode() should be utilized to reproduce the incorrect input. If the conversion was successful, or if there was no previous call to decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the value as appropriate. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1132 + if an input/output error occurs while rendering + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1133 + if context is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1134 + Render the child UIComponents of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property is true. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1135 + if an input/output error occurs while rendering + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1136 + if context is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1137 + Render the ending of the current state of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1138 + if an input/output error occurs while rendering + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1139 + if context is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1140 + Find the UIComponent named by the specified expression, if any is found. This is done by locating the closest parent UIComponent that is a NamingContainer, and calling its findComponentInNamespace() method. The specified expr may contain either a component identifier, or a set of component identifiers separated by SEPARATOR_CHAR characters. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1141 + if expr is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1142 + Return the value of the attribute with the specified name (if any); otherwise, return null. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1143 + if name is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1144 + Return an Iterator over the names of all currently defined attributes of this UIComponent that have a non-null value. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1145 + Return the UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 1146 + if index is out of range ((index = size())) + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 1147 + Return the number of UIComponents on the child list for this component. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1148 + Return an Iterator over the child UIComponents of this UIComponent, in the order of their position in the child list. If this component has no children, an empty Iterator is returned. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1149 + Return a client-side identifier for this component, generating one if necessary. Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1150 + if context is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1151 + Return the identifier of this UIComponent. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1152 + Return the converter id of the jakarta.faces.convert.Converter that is registered for this component. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1153 + Return the facet UIComponent associated with the specified name, if any. Otherwise, return null. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1154 + if name is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1155 + Return an Iterator over the names of the facet UIComponents of this UIComponent. If this component has no facets, an empty Iterator is returned. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1156 + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1157 + Return the parent UIComponent of this UIComponent, if any. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1158 + Return the Renderer type for this UIComponent (if any). + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1159 + Return a flag indicating whether this component is responsible for rendering its child components. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1160 + Return a flag indicating whether this component has concrete implementations of the decode() and encodeXxx() methods, and is therefore suitable for use in the direct implementation programming model for rendering. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1161 + Return an Iterator over the Validators associated with this UIComponent. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1162 + Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1163 + Return the current validity state of this component. The validity state of a component is adjusted at the following points during the request processing lifecycle: During the Apply Request Values phase, set to true or false by decode(), based on the success or failure of decoding a new local value for this component. During the Process Validations phase, set to false by processValidations() if any call to a validate() method returned false. During the Update Model Values phase, set to false by updateModel() if any conversion or update error occurred. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + + + 1164 + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1165 + if an input/output error occurs during decoding + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1166 + if context is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1167 + Perform the component tree processing required by the Reconstitute Component Tree phase of the request processing lifecyc,e for all facets of this component, all children of this component, and this component itself, as follows. Call the processReconstitutes() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). Call the reconstitute() method of this component. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1168 + if an input/output error occurs during processing + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1169 + if context is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1170 + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the updateModel() method of this component. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1171 + if context is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1172 + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property of this component is currently true: Call the validate() method of each Validator registered for this UIComponent. Call the validate() method of this component. Set the valid property of this component to the result returned from the validate() method. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1173 + if context is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1174 + Perform any processing required to correct the state of this component as a result of the owning component tree having been reconstructed during Reconstitute Component Tree phase of the request processing lifecycle. The default implementation of this method does nothing. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1175 + if an input/output error occurs during processing + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1176 + if context is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1177 + Remove the child UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 1178 + if the index is out of range ((index < 0) || (index >= size())) + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 1179 + Remove the child UIComponent from the child list for this component. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1180 + if component is not a child of this component + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1181 + if component is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1182 + Remove the facet UIComponent associated with the specified name, if there is one. The removed facet will have its parent property cleared. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1183 + if name is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1184 + Remove a Validator instance from the set associated with this UIComponent, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 1185 + Set the new value of the attribute with the specified name, replacing any existing value for that name. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + + + + + 1186 + if name represents a read-only property of this component + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalArgumentException + + + + + 1187 + if name is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 1188 + Set the identifier of this UIComponent. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1189 + if componentId is zero length or contains invalid characters + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1190 + if componentId is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1191 + if this UIComponent instance is already in the tree and and is not unique within the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1192 + Set the converter id of the jakarta.faces.convert.Converter that is registered for this component, or null to indicate that there is no registered Converter. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1193 + Set the parent UIComponent of this UIComponent. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1194 + Set the rendered property of this UIComponent. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 1195 + Set the Renderer type for this UIComponent, or null for components that render themselves. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1196 + Set the current validity state of this component. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 1197 + Add a new ValueChangedListener to the set of listeners interested in being notified when ValueChangedEvents occur. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.ValueChangedListener + + + + + + 1198 + if listener is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.ValueChangedListener + + java.lang.NullPointerException + + + + + 1199 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type, for the specified PhaseId. The order in which registered listeners are notified is implementation dependent. After all interested listeners have been notified, return false if this event does not have any listeners interested in this event in future phases of the request processing lifecycle. Otherwise, return true. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + + + + + 1200 + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + jakarta.faces.event.AbortProcessingException + + + + + 1201 + if the implementation class of this FacesEvent is not supported by this component + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalArgumentException + + + + + 1202 + if PhaseId.ANY_PHASE is passed for the phase identifier + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalStateException + + + + + 1203 + if event or phaseId is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.NullPointerException + + + + + 1204 + Return the previous value of this UIInput component. This method should only be utilized by the decode() method of this component, or its corresponding jakarta.faces.render.Renderer. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIInput} + + + + + 1205 + Remove an existing ValueChangedListener (if any) from the set of listeners interested in being notified when ValueChangedEvents occur. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.ValueChangedListener + + + + + + 1206 + if listener is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.ValueChangedListener + + java.lang.NullPointerException + + + + + 1207 + Set the previous value of this UIInput component. This method should only be utilized by the decode() method of this component, or its corresponding jakarta.faces.render.Renderer. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIInput} + + + java.lang.Object + + + + + + 1208 + Perform the following algorithm to update the model data associated with this UIInput, if any, as appropriate. If the valid property of this component is false, take no further action. If the valueRef property of this component is null, take no further action. Retrieve the Application instance for this web application from ApplicationFactory. Ask it for a ValueBinding for the valueRef expression. Use the setValue() method of the ValueBinding to update the value that the value reference expression points at. If the setValue() method returns successfully: Clear the local value of this UIInput. Set the valid property of this UIInput to true. If the setValue() method call fails: Enqueue error messages by calling addMessage() on the specified FacesContext instance. Set the valid property of this UIInput to false. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIInput} + + + jakarta.faces.context.FacesContext + + + + + + 1209 + if the valueRef property has invalid syntax for an expression + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIInput} + + + jakarta.faces.context.FacesContext + + java.lang.IllegalArgumentException + + + + + 1210 + if context is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIInput} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1211 + Perform validations and, if validation is successful, and the local value is different from the previous value, queue a ValueChangedEvent to be processed later. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIInput} + + + jakarta.faces.context.FacesContext + + + + + + 1212 + if context is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIInput} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1213 + Evaluate and return the current value of this component, according to the following algorithm. If the value property has been set (containing the local value for this component), return that; else If the valueRef property has been set, Retrieve the Application instance for this web application from ApplicationFactory. Ask it for a ValueBinding for the valueRef expression. Use the getValue() method of the ValueBinding to retrieve the value that the value reference expression points at. Otherwise, return null. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + + + + + 1214 + if a problem occurs evaluating the value reference expression + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + EvaluationException + + + + + 1215 + if context is null + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1216 + Return the component type of this UIComponent. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIOutput} + + + + + 1217 + Return the local value of this UIInput component. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIOutput} + + + + + 1218 + Return the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIOutput} + + + + + 1219 + Set the local value of this UIInput component. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIOutput} + + + java.lang.Object + + + + + + 1220 + Set the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UISelectBoolean.{jakarta.faces.component.UIOutput} + + + java.lang.String + + + + + + 1221 + Return the component type of this UIComponent. + jakarta.faces.component + UISelectItem + + + + + 1224 + Return the server value for this selection item. + jakarta.faces.component + UISelectItem + + + + + 1225 + Return true to indicate that no jakarta.faces.render.Renderer needs to be associated with this component. + jakarta.faces.component + UISelectItem + + + + + 1228 + Set the server value for this selection item. + jakarta.faces.component + UISelectItem + + + java.lang.String + + + + + + 1230 + Append the specified UIComponent to the end of the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1231 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1232 + if component is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1233 + Insert the specified UIComponent at the specified position in the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + + + + + 1234 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1235 + if the index is out of range ((index < 0) || (index > size())) + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IndexOutOfBoundsException + + + + + 1236 + if component is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1237 + Add the specified UIComponent as a facet associated with the name specified by the facetName argument, replacing any previous facet with that name. The newly added facet will have its parent property set to this component. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + 1238 + if the either of the facetName or facet arguments are null. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1239 + Add a Validator instance to the set associated with this UIComponent. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 1240 + if validator is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + java.lang.NullPointerException + + + + + 1241 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type, for the specified PhaseId (or for any phase, if the listener returns PhaseId.ANY_PHASE from its getPhaseId() method. The order in which registered listeners are notified is implementation dependent. After all interested listeners have been notified, return false if this event does not have any listeners interested in this event in future phases of the request processing lifecycle. Otherwise, return true. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + + + + + 1242 + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + jakarta.faces.event.AbortProcessingException + + + + + 1243 + if the implementation class of this FacesEvent is not supported by this component + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalArgumentException + + + + + 1244 + if PhaseId.ANY_PHASE is passed for the phase identifier + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalStateException + + + + + 1245 + if event or phaseId is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.NullPointerException + + + + + 1246 + Remove all child UIComponents from the child list. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1247 + Remove all facet UIComponents from this component. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1248 + Clear any Validators that have been registered for processing by this component. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1249 + Return true if the specified UIComponent is a direct child of this UIComponent; otherwise, return false. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1250 + if component is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1251 + Decode the current state of this UIComponent from the request contained in the specified FacesContext, and attempt to convert this state information into an object of the required type for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one. If conversion is successful: Save the new local value of this component by calling setValue() and passing the new value. Set the valid property of this component to true. If conversion is not successful: Save state information in such a way that encoding can reproduce the previous input (even though it was syntactically or semantically incorrect) Add an appropriate conversion failure error message by calling context.addMessage(). Set the valid property of this comonent to false. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1252 + if an input/output error occurs during decoding + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1253 + if context is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1254 + Render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. If the conversion attempted in a previous call to decode() for this component failed, the state information saved during execution of decode() should be utilized to reproduce the incorrect input. If the conversion was successful, or if there was no previous call to decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the value as appropriate. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1255 + if an input/output error occurs while rendering + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1256 + if context is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1257 + Render the child UIComponents of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property is true. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1258 + if an input/output error occurs while rendering + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1259 + if context is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1260 + Render the ending of the current state of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1261 + if an input/output error occurs while rendering + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1262 + if context is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1263 + Find the UIComponent named by the specified expression, if any is found. This is done by locating the closest parent UIComponent that is a NamingContainer, and calling its findComponentInNamespace() method. The specified expr may contain either a component identifier, or a set of component identifiers separated by SEPARATOR_CHAR characters. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1264 + if expr is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1265 + Return the value of the attribute with the specified name (if any); otherwise, return null. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1266 + if name is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1267 + Return an Iterator over the names of all currently defined attributes of this UIComponent that have a non-null value. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1268 + Return the UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 1269 + if index is out of range ((index = size())) + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 1270 + Return the number of UIComponents on the child list for this component. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1271 + Return an Iterator over the child UIComponents of this UIComponent, in the order of their position in the child list. If this component has no children, an empty Iterator is returned. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1272 + Return a client-side identifier for this component, generating one if necessary. Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1273 + if context is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1274 + Return the identifier of this UIComponent. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1275 + Return the component type of this UIComponent. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1276 + Return the converter id of the jakarta.faces.convert.Converter that is registered for this component. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1277 + Return the facet UIComponent associated with the specified name, if any. Otherwise, return null. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1278 + if name is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1279 + Return an Iterator over the names of the facet UIComponents of this UIComponent. If this component has no facets, an empty Iterator is returned. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1280 + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1281 + Return the parent UIComponent of this UIComponent, if any. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1282 + Return the Renderer type for this UIComponent (if any). + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1283 + Return a flag indicating whether this component is responsible for rendering its child components. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1284 + Return an Iterator over the Validators associated with this UIComponent. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1285 + Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1286 + Return the current validity state of this component. The validity state of a component is adjusted at the following points during the request processing lifecycle: During the Apply Request Values phase, set to true or false by decode(), based on the success or failure of decoding a new local value for this component. During the Process Validations phase, set to false by processValidations() if any call to a validate() method returned false. During the Update Model Values phase, set to false by updateModel() if any conversion or update error occurred. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + + + 1287 + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1288 + if an input/output error occurs during decoding + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1289 + if context is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1290 + Perform the component tree processing required by the Reconstitute Component Tree phase of the request processing lifecyc,e for all facets of this component, all children of this component, and this component itself, as follows. Call the processReconstitutes() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). Call the reconstitute() method of this component. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1291 + if an input/output error occurs during processing + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1292 + if context is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1293 + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the updateModel() method of this component. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1294 + if context is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1295 + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property of this component is currently true: Call the validate() method of each Validator registered for this UIComponent. Call the validate() method of this component. Set the valid property of this component to the result returned from the validate() method. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1296 + if context is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1297 + Perform any processing required to correct the state of this component as a result of the owning component tree having been reconstructed during Reconstitute Component Tree phase of the request processing lifecycle. The default implementation of this method does nothing. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1298 + if an input/output error occurs during processing + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1299 + if context is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1300 + Remove the child UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 1301 + if the index is out of range ((index < 0) || (index >= size())) + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 1302 + Remove the child UIComponent from the child list for this component. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1303 + if component is not a child of this component + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1304 + if component is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1305 + Remove the facet UIComponent associated with the specified name, if there is one. The removed facet will have its parent property cleared. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1306 + if name is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1307 + Remove a Validator instance from the set associated with this UIComponent, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 1308 + Set the new value of the attribute with the specified name, replacing any existing value for that name. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + + + + + 1309 + if name represents a read-only property of this component + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalArgumentException + + + + + 1310 + if name is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 1311 + Set the identifier of this UIComponent. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1312 + if componentId is zero length or contains invalid characters + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1313 + if componentId is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1314 + if this UIComponent instance is already in the tree and and is not unique within the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1315 + Set the converter id of the jakarta.faces.convert.Converter that is registered for this component, or null to indicate that there is no registered Converter. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1316 + Set the parent UIComponent of this UIComponent. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1317 + Set the rendered property of this UIComponent. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 1318 + Set the Renderer type for this UIComponent, or null for components that render themselves. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1319 + Set the current validity state of this component. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 1320 + Update the model data associated with this UIComponent, if any. The default implementation in UIComponentBase does no processing; concrete implementations of components that represent controls that can be altered by users (such as UIInput must provide an apppropriate implementation of this method. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1321 + if context is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1322 + Perform any correctness checks that this component wishes to perform on itself. This method will be called during the Process Validations phase of the request processing lifecycle. If errors are encountered, appropriate Message instances should be added to the FacesContext for the current request, and the valid property of this UIComponent should be set to false. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1323 + if context is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1324 + Evaluate and return the current value of this component, according to the following algorithm. If the value property has been set (containing the local value for this component), return that; else If the valueRef property has been set, Retrieve the Application instance for this web application from ApplicationFactory. Ask it for a ValueBinding for the valueRef expression. Use the getValue() method of the ValueBinding to retrieve the value that the value reference expression points at. Otherwise, return null. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + + + + + 1325 + if a problem occurs evaluating the value reference expression + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + EvaluationException + + + + + 1326 + if context is null + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1327 + Return the local value of this UIInput component. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIOutput} + + + + + 1328 + Return the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIOutput} + + + + + 1329 + Set the local value of this UIInput component. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIOutput} + + + java.lang.Object + + + + + + 1330 + Set the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UISelectItem.{jakarta.faces.component.UIOutput} + + + java.lang.String + + + + + + 1331 + Return the component type of this UIComponent. + jakarta.faces.component + UISelectItems + + + + + 1332 + Return true to indicate that no jakarta.faces.render.Renderer needs to be associated with this component. + jakarta.faces.component + UISelectItems + + + + + 1334 + Append the specified UIComponent to the end of the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1335 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1336 + if component is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1337 + Insert the specified UIComponent at the specified position in the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + + + + + 1338 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1339 + if the index is out of range ((index < 0) || (index > size())) + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IndexOutOfBoundsException + + + + + 1340 + if component is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1341 + Add the specified UIComponent as a facet associated with the name specified by the facetName argument, replacing any previous facet with that name. The newly added facet will have its parent property set to this component. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + 1342 + if the either of the facetName or facet arguments are null. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1343 + Add a Validator instance to the set associated with this UIComponent. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 1344 + if validator is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + java.lang.NullPointerException + + + + + 1345 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type, for the specified PhaseId (or for any phase, if the listener returns PhaseId.ANY_PHASE from its getPhaseId() method. The order in which registered listeners are notified is implementation dependent. After all interested listeners have been notified, return false if this event does not have any listeners interested in this event in future phases of the request processing lifecycle. Otherwise, return true. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + + + + + 1346 + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + jakarta.faces.event.AbortProcessingException + + + + + 1347 + if the implementation class of this FacesEvent is not supported by this component + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalArgumentException + + + + + 1348 + if PhaseId.ANY_PHASE is passed for the phase identifier + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalStateException + + + + + 1349 + if event or phaseId is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.NullPointerException + + + + + 1350 + Remove all child UIComponents from the child list. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1351 + Remove all facet UIComponents from this component. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1352 + Clear any Validators that have been registered for processing by this component. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1353 + Return true if the specified UIComponent is a direct child of this UIComponent; otherwise, return false. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1354 + if component is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1355 + Decode the current state of this UIComponent from the request contained in the specified FacesContext, and attempt to convert this state information into an object of the required type for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one. If conversion is successful: Save the new local value of this component by calling setValue() and passing the new value. Set the valid property of this component to true. If conversion is not successful: Save state information in such a way that encoding can reproduce the previous input (even though it was syntactically or semantically incorrect) Add an appropriate conversion failure error message by calling context.addMessage(). Set the valid property of this comonent to false. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1356 + if an input/output error occurs during decoding + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1357 + if context is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1358 + Render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. If the conversion attempted in a previous call to decode() for this component failed, the state information saved during execution of decode() should be utilized to reproduce the incorrect input. If the conversion was successful, or if there was no previous call to decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the value as appropriate. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1359 + if an input/output error occurs while rendering + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1360 + if context is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1361 + Render the child UIComponents of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property is true. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1362 + if an input/output error occurs while rendering + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1363 + if context is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1364 + Render the ending of the current state of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1365 + if an input/output error occurs while rendering + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1366 + if context is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1367 + Find the UIComponent named by the specified expression, if any is found. This is done by locating the closest parent UIComponent that is a NamingContainer, and calling its findComponentInNamespace() method. The specified expr may contain either a component identifier, or a set of component identifiers separated by SEPARATOR_CHAR characters. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1368 + if expr is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1369 + Return the value of the attribute with the specified name (if any); otherwise, return null. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1370 + if name is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1371 + Return an Iterator over the names of all currently defined attributes of this UIComponent that have a non-null value. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1372 + Return the UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 1373 + if index is out of range ((index = size())) + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 1374 + Return the number of UIComponents on the child list for this component. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1375 + Return an Iterator over the child UIComponents of this UIComponent, in the order of their position in the child list. If this component has no children, an empty Iterator is returned. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1376 + Return a client-side identifier for this component, generating one if necessary. Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1377 + if context is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1378 + Return the identifier of this UIComponent. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1379 + Return the component type of this UIComponent. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1380 + Return the converter id of the jakarta.faces.convert.Converter that is registered for this component. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1381 + Return the facet UIComponent associated with the specified name, if any. Otherwise, return null. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1382 + if name is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1383 + Return an Iterator over the names of the facet UIComponents of this UIComponent. If this component has no facets, an empty Iterator is returned. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1384 + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1385 + Return the parent UIComponent of this UIComponent, if any. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1386 + Return the Renderer type for this UIComponent (if any). + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1387 + Return a flag indicating whether this component is responsible for rendering its child components. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1388 + Return an Iterator over the Validators associated with this UIComponent. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1389 + Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1390 + Return the current validity state of this component. The validity state of a component is adjusted at the following points during the request processing lifecycle: During the Apply Request Values phase, set to true or false by decode(), based on the success or failure of decoding a new local value for this component. During the Process Validations phase, set to false by processValidations() if any call to a validate() method returned false. During the Update Model Values phase, set to false by updateModel() if any conversion or update error occurred. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + + + 1391 + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1392 + if an input/output error occurs during decoding + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1393 + if context is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1394 + Perform the component tree processing required by the Reconstitute Component Tree phase of the request processing lifecyc,e for all facets of this component, all children of this component, and this component itself, as follows. Call the processReconstitutes() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). Call the reconstitute() method of this component. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1395 + if an input/output error occurs during processing + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1396 + if context is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1397 + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the updateModel() method of this component. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1398 + if context is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1399 + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property of this component is currently true: Call the validate() method of each Validator registered for this UIComponent. Call the validate() method of this component. Set the valid property of this component to the result returned from the validate() method. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1400 + if context is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1401 + Perform any processing required to correct the state of this component as a result of the owning component tree having been reconstructed during Reconstitute Component Tree phase of the request processing lifecycle. The default implementation of this method does nothing. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1402 + if an input/output error occurs during processing + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1403 + if context is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1404 + Remove the child UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 1405 + if the index is out of range ((index < 0) || (index >= size())) + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 1406 + Remove the child UIComponent from the child list for this component. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1407 + if component is not a child of this component + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1408 + if component is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1409 + Remove the facet UIComponent associated with the specified name, if there is one. The removed facet will have its parent property cleared. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1410 + if name is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1411 + Remove a Validator instance from the set associated with this UIComponent, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 1412 + Set the new value of the attribute with the specified name, replacing any existing value for that name. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + + + + + 1413 + if name represents a read-only property of this component + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalArgumentException + + + + + 1414 + if name is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 1415 + Set the identifier of this UIComponent. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1416 + if componentId is zero length or contains invalid characters + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1417 + if componentId is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1418 + if this UIComponent instance is already in the tree and and is not unique within the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1419 + Set the converter id of the jakarta.faces.convert.Converter that is registered for this component, or null to indicate that there is no registered Converter. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1420 + Set the parent UIComponent of this UIComponent. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1421 + Set the rendered property of this UIComponent. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 1422 + Set the Renderer type for this UIComponent, or null for components that render themselves. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1423 + Set the current validity state of this component. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 1424 + Update the model data associated with this UIComponent, if any. The default implementation in UIComponentBase does no processing; concrete implementations of components that represent controls that can be altered by users (such as UIInput must provide an apppropriate implementation of this method. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1425 + if context is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1426 + Perform any correctness checks that this component wishes to perform on itself. This method will be called during the Process Validations phase of the request processing lifecycle. If errors are encountered, appropriate Message instances should be added to the FacesContext for the current request, and the valid property of this UIComponent should be set to false. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1427 + if context is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1428 + Evaluate and return the current value of this component, according to the following algorithm. If the value property has been set (containing the local value for this component), return that; else If the valueRef property has been set, Retrieve the Application instance for this web application from ApplicationFactory. Ask it for a ValueBinding for the valueRef expression. Use the getValue() method of the ValueBinding to retrieve the value that the value reference expression points at. Otherwise, return null. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + + + + + 1429 + if a problem occurs evaluating the value reference expression + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + EvaluationException + + + + + 1430 + if context is null + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1431 + Return the local value of this UIInput component. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIOutput} + + + + + 1432 + Return the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIOutput} + + + + + 1433 + Set the local value of this UIInput component. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIOutput} + + + java.lang.Object + + + + + + 1434 + Set the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UISelectItems.{jakarta.faces.component.UIOutput} + + + java.lang.String + + + + + + 1435 + Return the component type of this UIComponent. + jakarta.faces.component + UISelectMany + + + + + 1439 + Append the specified UIComponent to the end of the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1440 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1441 + if component is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1442 + Insert the specified UIComponent at the specified position in the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + + + + + 1443 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1444 + if the index is out of range ((index < 0) || (index > size())) + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IndexOutOfBoundsException + + + + + 1445 + if component is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1446 + Add the specified UIComponent as a facet associated with the name specified by the facetName argument, replacing any previous facet with that name. The newly added facet will have its parent property set to this component. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + 1447 + if the either of the facetName or facet arguments are null. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1448 + Add a Validator instance to the set associated with this UIComponent. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 1449 + if validator is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + java.lang.NullPointerException + + + + + 1450 + Remove all child UIComponents from the child list. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1451 + Remove all facet UIComponents from this component. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1452 + Clear any Validators that have been registered for processing by this component. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1453 + Return true if the specified UIComponent is a direct child of this UIComponent; otherwise, return false. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1454 + if component is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1455 + Decode the current state of this UIComponent from the request contained in the specified FacesContext, and attempt to convert this state information into an object of the required type for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one. If conversion is successful: Save the new local value of this component by calling setValue() and passing the new value. Set the valid property of this component to true. If conversion is not successful: Save state information in such a way that encoding can reproduce the previous input (even though it was syntactically or semantically incorrect) Add an appropriate conversion failure error message by calling context.addMessage(). Set the valid property of this comonent to false. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1456 + if an input/output error occurs during decoding + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1457 + if context is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1458 + Render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. If the conversion attempted in a previous call to decode() for this component failed, the state information saved during execution of decode() should be utilized to reproduce the incorrect input. If the conversion was successful, or if there was no previous call to decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the value as appropriate. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1459 + if an input/output error occurs while rendering + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1460 + if context is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1461 + Render the child UIComponents of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property is true. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1462 + if an input/output error occurs while rendering + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1463 + if context is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1464 + Render the ending of the current state of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1465 + if an input/output error occurs while rendering + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1466 + if context is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1467 + Find the UIComponent named by the specified expression, if any is found. This is done by locating the closest parent UIComponent that is a NamingContainer, and calling its findComponentInNamespace() method. The specified expr may contain either a component identifier, or a set of component identifiers separated by SEPARATOR_CHAR characters. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1468 + if expr is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1469 + Return the value of the attribute with the specified name (if any); otherwise, return null. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1470 + if name is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1471 + Return an Iterator over the names of all currently defined attributes of this UIComponent that have a non-null value. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1472 + Return the UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 1473 + if index is out of range ((index = size())) + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 1474 + Return the number of UIComponents on the child list for this component. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1475 + Return an Iterator over the child UIComponents of this UIComponent, in the order of their position in the child list. If this component has no children, an empty Iterator is returned. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1476 + Return a client-side identifier for this component, generating one if necessary. Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1477 + if context is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1478 + Return the identifier of this UIComponent. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1479 + Return the converter id of the jakarta.faces.convert.Converter that is registered for this component. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1480 + Return the facet UIComponent associated with the specified name, if any. Otherwise, return null. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1481 + if name is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1482 + Return an Iterator over the names of the facet UIComponents of this UIComponent. If this component has no facets, an empty Iterator is returned. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1483 + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1484 + Return the parent UIComponent of this UIComponent, if any. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1485 + Return the Renderer type for this UIComponent (if any). + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1486 + Return a flag indicating whether this component is responsible for rendering its child components. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1487 + Return a flag indicating whether this component has concrete implementations of the decode() and encodeXxx() methods, and is therefore suitable for use in the direct implementation programming model for rendering. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1488 + Return an Iterator over the Validators associated with this UIComponent. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1489 + Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1490 + Return the current validity state of this component. The validity state of a component is adjusted at the following points during the request processing lifecycle: During the Apply Request Values phase, set to true or false by decode(), based on the success or failure of decoding a new local value for this component. During the Process Validations phase, set to false by processValidations() if any call to a validate() method returned false. During the Update Model Values phase, set to false by updateModel() if any conversion or update error occurred. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + + + 1491 + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1492 + if an input/output error occurs during decoding + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1493 + if context is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1494 + Perform the component tree processing required by the Reconstitute Component Tree phase of the request processing lifecyc,e for all facets of this component, all children of this component, and this component itself, as follows. Call the processReconstitutes() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). Call the reconstitute() method of this component. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1495 + if an input/output error occurs during processing + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1496 + if context is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1497 + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the updateModel() method of this component. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1498 + if context is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1499 + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property of this component is currently true: Call the validate() method of each Validator registered for this UIComponent. Call the validate() method of this component. Set the valid property of this component to the result returned from the validate() method. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1500 + if context is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1501 + Perform any processing required to correct the state of this component as a result of the owning component tree having been reconstructed during Reconstitute Component Tree phase of the request processing lifecycle. The default implementation of this method does nothing. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1502 + if an input/output error occurs during processing + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1503 + if context is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1504 + Remove the child UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 1505 + if the index is out of range ((index < 0) || (index >= size())) + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 1506 + Remove the child UIComponent from the child list for this component. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1507 + if component is not a child of this component + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1508 + if component is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1509 + Remove the facet UIComponent associated with the specified name, if there is one. The removed facet will have its parent property cleared. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1510 + if name is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1511 + Remove a Validator instance from the set associated with this UIComponent, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 1512 + Set the new value of the attribute with the specified name, replacing any existing value for that name. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + + + + + 1513 + if name represents a read-only property of this component + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalArgumentException + + + + + 1514 + if name is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 1515 + Set the identifier of this UIComponent. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1516 + if componentId is zero length or contains invalid characters + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1517 + if componentId is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1518 + if this UIComponent instance is already in the tree and and is not unique within the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1519 + Set the converter id of the jakarta.faces.convert.Converter that is registered for this component, or null to indicate that there is no registered Converter. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1520 + Set the parent UIComponent of this UIComponent. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1521 + Set the rendered property of this UIComponent. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 1522 + Set the Renderer type for this UIComponent, or null for components that render themselves. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1523 + Set the current validity state of this component. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 1524 + Add a new ValueChangedListener to the set of listeners interested in being notified when ValueChangedEvents occur. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.ValueChangedListener + + + + + + 1525 + if listener is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.ValueChangedListener + + java.lang.NullPointerException + + + + + 1526 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type, for the specified PhaseId. The order in which registered listeners are notified is implementation dependent. After all interested listeners have been notified, return false if this event does not have any listeners interested in this event in future phases of the request processing lifecycle. Otherwise, return true. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + + + + + 1527 + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + jakarta.faces.event.AbortProcessingException + + + + + 1528 + if the implementation class of this FacesEvent is not supported by this component + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalArgumentException + + + + + 1529 + if PhaseId.ANY_PHASE is passed for the phase identifier + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalStateException + + + + + 1530 + if event or phaseId is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.NullPointerException + + + + + 1531 + Return the previous value of this UIInput component. This method should only be utilized by the decode() method of this component, or its corresponding jakarta.faces.render.Renderer. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIInput} + + + + + 1532 + Remove an existing ValueChangedListener (if any) from the set of listeners interested in being notified when ValueChangedEvents occur. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.ValueChangedListener + + + + + + 1533 + if listener is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.ValueChangedListener + + java.lang.NullPointerException + + + + + 1534 + Set the previous value of this UIInput component. This method should only be utilized by the decode() method of this component, or its corresponding jakarta.faces.render.Renderer. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIInput} + + + java.lang.Object + + + + + + 1535 + Perform the following algorithm to update the model data associated with this UIInput, if any, as appropriate. If the valid property of this component is false, take no further action. If the valueRef property of this component is null, take no further action. Retrieve the Application instance for this web application from ApplicationFactory. Ask it for a ValueBinding for the valueRef expression. Use the setValue() method of the ValueBinding to update the value that the value reference expression points at. If the setValue() method returns successfully: Clear the local value of this UIInput. Set the valid property of this UIInput to true. If the setValue() method call fails: Enqueue error messages by calling addMessage() on the specified FacesContext instance. Set the valid property of this UIInput to false. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIInput} + + + jakarta.faces.context.FacesContext + + + + + + 1536 + if the valueRef property has invalid syntax for an expression + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIInput} + + + jakarta.faces.context.FacesContext + + java.lang.IllegalArgumentException + + + + + 1537 + if context is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIInput} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1538 + Perform validations and, if validation is successful, and the local value is different from the previous value, queue a ValueChangedEvent to be processed later. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIInput} + + + jakarta.faces.context.FacesContext + + + + + + 1539 + if context is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIInput} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1540 + Evaluate and return the current value of this component, according to the following algorithm. If the value property has been set (containing the local value for this component), return that; else If the valueRef property has been set, Retrieve the Application instance for this web application from ApplicationFactory. Ask it for a ValueBinding for the valueRef expression. Use the getValue() method of the ValueBinding to retrieve the value that the value reference expression points at. Otherwise, return null. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + + + + + 1541 + if a problem occurs evaluating the value reference expression + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + EvaluationException + + + + + 1542 + if context is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1543 + Return the component type of this UIComponent. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIOutput} + + + + + 1544 + Return the local value of this UIInput component. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIOutput} + + + + + 1545 + Return the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIOutput} + + + + + 1546 + Set the local value of this UIInput component. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIOutput} + + + java.lang.Object + + + + + + 1547 + Set the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UIOutput} + + + java.lang.String + + + + + + 1548 + Add the specified UIComponent to the namespace of this naming container. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UISelectBase} + + + jakarta.faces.component.UIComponent + + + + + + 1549 + if the specified component does not have a componentId + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UISelectBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1550 + if the component identifier of the specified component is not unique within the namespace of this naming container + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UISelectBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalStateException + + + + + 1551 + if component is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UISelectBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1552 + Find and return a UIComponent in this namespace, if it is present; otherwise return null. If the argument name does not contain any UIComponent#SEPARATOR_CHAR characters, it is interpreted to be a name in the namespace of this naming container. If the argument name does contain UIComponent#SEPARATOR_CHAR characters, each segment between UIComponent#SEPARATOR_CHAR is treated as a component identifier in its own namespace, which are searched for in child naming containers of this naming container, from left to right. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UISelectBase} + + + java.lang.String + + + + + + 1553 + if name is malformed + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UISelectBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1554 + if name is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UISelectBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1555 + Generate an identifier for a component, suitable for communication to a client. The identifier returned from this method must be unique within this namespace. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UISelectBase} + + + + + 1556 + Remove the specified UIComponent from the namespace of this naming container, if it is present. + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UISelectBase} + + + jakarta.faces.component.UIComponent + + + + + + 1557 + if the specified component does not have a componentId + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UISelectBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1558 + if component is null + jakarta.faces.component + UISelectMany.{jakarta.faces.component.UISelectBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1559 + Return the component type of this UIComponent. + jakarta.faces.component + UISelectOne + + + + + 1560 + Return the currently selected item, or null if there is no currently selected item. + jakarta.faces.component + UISelectOne + + + + + 1561 + Set the currently selected item, or null to indicate that there is no currently selected item. + jakarta.faces.component + UISelectOne + + + java.lang.Object + + + + + + 1563 + Append the specified UIComponent to the end of the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1564 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1565 + if component is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1566 + Insert the specified UIComponent at the specified position in the child list for this component. If the child to be added has a non-null and valid component identifier, the identifier is added to the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + + + + + 1567 + if the component identifier of the new component is non-null, and is not unique in the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1568 + if the index is out of range ((index < 0) || (index > size())) + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.IndexOutOfBoundsException + + + + + 1569 + if component is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + int + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1570 + Add the specified UIComponent as a facet associated with the name specified by the facetName argument, replacing any previous facet with that name. The newly added facet will have its parent property set to this component. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + 1571 + if the either of the facetName or facet arguments are null. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1572 + Add a Validator instance to the set associated with this UIComponent. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 1573 + if validator is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + java.lang.NullPointerException + + + + + 1574 + Remove all child UIComponents from the child list. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1575 + Remove all facet UIComponents from this component. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1576 + Clear any Validators that have been registered for processing by this component. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1577 + Return true if the specified UIComponent is a direct child of this UIComponent; otherwise, return false. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1578 + if component is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1579 + Decode the current state of this UIComponent from the request contained in the specified FacesContext, and attempt to convert this state information into an object of the required type for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one. If conversion is successful: Save the new local value of this component by calling setValue() and passing the new value. Set the valid property of this component to true. If conversion is not successful: Save state information in such a way that encoding can reproduce the previous input (even though it was syntactically or semantically incorrect) Add an appropriate conversion failure error message by calling context.addMessage(). Set the valid property of this comonent to false. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling addFacesEvent() on the associated FacesContext. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1580 + if an input/output error occurs during decoding + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1581 + if context is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1582 + Render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. If the conversion attempted in a previous call to decode() for this component failed, the state information saved during execution of decode() should be utilized to reproduce the incorrect input. If the conversion was successful, or if there was no previous call to decode(), the value to be displayed should be acquired by calling currentValue(), and rendering the value as appropriate. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1583 + if an input/output error occurs while rendering + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1584 + if context is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1585 + Render the child UIComponents of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property is true. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1586 + if an input/output error occurs while rendering + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1587 + if context is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1588 + Render the ending of the current state of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1589 + if an input/output error occurs while rendering + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1590 + if context is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1591 + Find the UIComponent named by the specified expression, if any is found. This is done by locating the closest parent UIComponent that is a NamingContainer, and calling its findComponentInNamespace() method. The specified expr may contain either a component identifier, or a set of component identifiers separated by SEPARATOR_CHAR characters. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1592 + if expr is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1593 + Return the value of the attribute with the specified name (if any); otherwise, return null. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1594 + if name is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1595 + Return an Iterator over the names of all currently defined attributes of this UIComponent that have a non-null value. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1596 + Return the UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 1597 + if index is out of range ((index = size())) + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 1598 + Return the number of UIComponents on the child list for this component. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1599 + Return an Iterator over the child UIComponents of this UIComponent, in the order of their position in the child list. If this component has no children, an empty Iterator is returned. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1600 + Return a client-side identifier for this component, generating one if necessary. Generation will be delegated to the associated jakarta.faces.render.Renderer (if there is one). + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1601 + if context is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1602 + Return the identifier of this UIComponent. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1603 + Return the converter id of the jakarta.faces.convert.Converter that is registered for this component. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1604 + Return the facet UIComponent associated with the specified name, if any. Otherwise, return null. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1605 + if name is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1606 + Return an Iterator over the names of the facet UIComponents of this UIComponent. If this component has no facets, an empty Iterator is returned. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1607 + Return an Iterator over the facet followed by child UIComponents of this UIComponent. Facets are returned in an undefined order, followed by all the children in the order they are stored in the child list. If this component has no facets or children, an empty Iterator is returned. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1608 + Return the parent UIComponent of this UIComponent, if any. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1609 + Return the Renderer type for this UIComponent (if any). + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1610 + Return a flag indicating whether this component is responsible for rendering its child components. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1611 + Return a flag indicating whether this component has concrete implementations of the decode() and encodeXxx() methods, and is therefore suitable for use in the direct implementation programming model for rendering. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1612 + Return an Iterator over the Validators associated with this UIComponent. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1613 + Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1614 + Return the current validity state of this component. The validity state of a component is adjusted at the following points during the request processing lifecycle: During the Apply Request Values phase, set to true or false by decode(), based on the success or failure of decoding a new local value for this component. During the Process Validations phase, set to false by processValidations() if any call to a validate() method returned false. During the Update Model Values phase, set to false by updateModel() if any conversion or update error occurred. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + + + 1615 + Perform the component tree processing required by the Apply Request Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processDecodes() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the decode() method of this component. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1616 + if an input/output error occurs during decoding + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1617 + if context is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1618 + Perform the component tree processing required by the Reconstitute Component Tree phase of the request processing lifecyc,e for all facets of this component, all children of this component, and this component itself, as follows. Call the processReconstitutes() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). Call the reconstitute() method of this component. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1619 + if an input/output error occurs during processing + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1620 + if context is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1621 + Perform the component tree processing required by the Update Model Values phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processUpdates() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). Call the updateModel() method of this component. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1622 + if context is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1623 + Perform the component tree processing required by the Process Validations phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the processValidators() method of all facets and children of this UIComponent, in the order determined by a call to getFacetsAndChildren(). If the valid property of this component is currently true: Call the validate() method of each Validator registered for this UIComponent. Call the validate() method of this component. Set the valid property of this component to the result returned from the validate() method. If the valid property of this UIComponent is now false, call FacesContext.renderResponse() to transfer control at the end of the current phase. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1624 + if context is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1625 + Perform any processing required to correct the state of this component as a result of the owning component tree having been reconstructed during Reconstitute Component Tree phase of the request processing lifecycle. The default implementation of this method does nothing. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + + + + + 1626 + if an input/output error occurs during processing + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1627 + if context is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1628 + Remove the child UIComponent at the specified position in the child list for this component. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + int + + + + + + 1629 + if the index is out of range ((index < 0) || (index >= size())) + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + int + + java.lang.IndexOutOfBoundsException + + + + + 1630 + Remove the child UIComponent from the child list for this component. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1631 + if component is not a child of this component + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1632 + if component is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1633 + Remove the facet UIComponent associated with the specified name, if there is one. The removed facet will have its parent property cleared. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1634 + if name is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1635 + Remove a Validator instance from the set associated with this UIComponent, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.validator.Validator + + + + + + 1636 + Set the new value of the attribute with the specified name, replacing any existing value for that name. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + + + + + 1637 + if name represents a read-only property of this component + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalArgumentException + + + + + 1638 + if name is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 1639 + Set the identifier of this UIComponent. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1640 + if componentId is zero length or contains invalid characters + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1641 + if componentId is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1642 + if this UIComponent instance is already in the tree and and is not unique within the namespace of the closest ancestor that is a naming container. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1643 + Set the converter id of the jakarta.faces.convert.Converter that is registered for this component, or null to indicate that there is no registered Converter. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1644 + Set the parent UIComponent of this UIComponent. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + jakarta.faces.component.UIComponent + + + + + + 1645 + Set the rendered property of this UIComponent. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 1646 + Set the Renderer type for this UIComponent, or null for components that render themselves. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + java.lang.String + + + + + + 1647 + Set the current validity state of this component. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIComponentBase} + + + boolean + + + + + + 1648 + Add a new ValueChangedListener to the set of listeners interested in being notified when ValueChangedEvents occur. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.ValueChangedListener + + + + + + 1649 + if listener is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.ValueChangedListener + + java.lang.NullPointerException + + + + + 1650 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type, for the specified PhaseId. The order in which registered listeners are notified is implementation dependent. After all interested listeners have been notified, return false if this event does not have any listeners interested in this event in future phases of the request processing lifecycle. Otherwise, return true. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + + + + + 1651 + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + jakarta.faces.event.AbortProcessingException + + + + + 1652 + if the implementation class of this FacesEvent is not supported by this component + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalArgumentException + + + + + 1653 + if PhaseId.ANY_PHASE is passed for the phase identifier + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.IllegalStateException + + + + + 1654 + if event or phaseId is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.FacesEvent + jakarta.faces.event.PhaseId + + java.lang.NullPointerException + + + + + 1655 + Return the previous value of this UIInput component. This method should only be utilized by the decode() method of this component, or its corresponding jakarta.faces.render.Renderer. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIInput} + + + + + 1656 + Remove an existing ValueChangedListener (if any) from the set of listeners interested in being notified when ValueChangedEvents occur. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.ValueChangedListener + + + + + + 1657 + if listener is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIInput} + + + jakarta.faces.event.ValueChangedListener + + java.lang.NullPointerException + + + + + 1658 + Set the previous value of this UIInput component. This method should only be utilized by the decode() method of this component, or its corresponding jakarta.faces.render.Renderer. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIInput} + + + java.lang.Object + + + + + + 1659 + Perform the following algorithm to update the model data associated with this UIInput, if any, as appropriate. If the valid property of this component is false, take no further action. If the valueRef property of this component is null, take no further action. Retrieve the Application instance for this web application from ApplicationFactory. Ask it for a ValueBinding for the valueRef expression. Use the setValue() method of the ValueBinding to update the value that the value reference expression points at. If the setValue() method returns successfully: Clear the local value of this UIInput. Set the valid property of this UIInput to true. If the setValue() method call fails: Enqueue error messages by calling addMessage() on the specified FacesContext instance. Set the valid property of this UIInput to false. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIInput} + + + jakarta.faces.context.FacesContext + + + + + + 1660 + if the valueRef property has invalid syntax for an expression + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIInput} + + + jakarta.faces.context.FacesContext + + java.lang.IllegalArgumentException + + + + + 1661 + if context is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIInput} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1662 + Perform validations and, if validation is successful, and the local value is different from the previous value, queue a ValueChangedEvent to be processed later. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIInput} + + + jakarta.faces.context.FacesContext + + + + + + 1663 + if context is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIInput} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1664 + Evaluate and return the current value of this component, according to the following algorithm. If the value property has been set (containing the local value for this component), return that; else If the valueRef property has been set, Retrieve the Application instance for this web application from ApplicationFactory. Ask it for a ValueBinding for the valueRef expression. Use the getValue() method of the ValueBinding to retrieve the value that the value reference expression points at. Otherwise, return null. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + + + + + 1665 + if a problem occurs evaluating the value reference expression + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + EvaluationException + + + + + 1666 + if context is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIOutput} + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1667 + Return the component type of this UIComponent. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIOutput} + + + + + 1668 + Return the local value of this UIInput component. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIOutput} + + + + + 1669 + Return the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIOutput} + + + + + 1670 + Set the local value of this UIInput component. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIOutput} + + + java.lang.Object + + + + + + 1671 + Set the value reference expression for this UIInput component, pointing at the model tier property that will be updated or rendered. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UIOutput} + + + java.lang.String + + + + + + 1672 + Add the specified UIComponent to the namespace of this naming container. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UISelectBase} + + + jakarta.faces.component.UIComponent + + + + + + 1673 + if the specified component does not have a componentId + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UISelectBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1674 + if the component identifier of the specified component is not unique within the namespace of this naming container + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UISelectBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalStateException + + + + + 1675 + if component is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UISelectBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1676 + Find and return a UIComponent in this namespace, if it is present; otherwise return null. If the argument name does not contain any UIComponent#SEPARATOR_CHAR characters, it is interpreted to be a name in the namespace of this naming container. If the argument name does contain UIComponent#SEPARATOR_CHAR characters, each segment between UIComponent#SEPARATOR_CHAR is treated as a component identifier in its own namespace, which are searched for in child naming containers of this naming container, from left to right. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UISelectBase} + + + java.lang.String + + + + + + 1677 + if name is malformed + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UISelectBase} + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1678 + if name is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UISelectBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 1679 + Generate an identifier for a component, suitable for communication to a client. The identifier returned from this method must be unique within this namespace. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UISelectBase} + + + + + 1680 + Remove the specified UIComponent from the namespace of this naming container, if it is present. + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UISelectBase} + + + jakarta.faces.component.UIComponent + + + + + + 1681 + if the specified component does not have a componentId + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UISelectBase} + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1682 + if component is null + jakarta.faces.component + UISelectOne.{jakarta.faces.component.UISelectBase} + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1683 + Append a FacesEvent to the set of events that should be processed at the end of the current phase of the request processing lifecycle. + jakarta.faces.context + FacesContext + + + jakarta.faces.event.FacesEvent + + + + + + 1684 + if event is null + jakarta.faces.context + FacesContext + + + jakarta.faces.event.FacesEvent + + java.lang.NullPointerException + + + + + 1685 + Append a Message to the set of messages associated with the specified UIComponent, if component is not null. If component is null, this Message is assumed to not be associated with any specific component instance. + jakarta.faces.context + FacesContext + + + jakarta.faces.component.UIComponent + jakarta.faces.context.Message + + + + + + 1686 + if message is null + jakarta.faces.context + FacesContext + + + jakarta.faces.component.UIComponent + jakarta.faces.context.Message + + java.lang.NullPointerException + + + + + 1689 + Return an Iterator over the FacesEvents that have been queued, in the order that they were queued. The Iterator returned by this method must support the following functionality: The remove() operation may be utilized by the JSF implementation to remove the current event when it has been completely handled. Event handlers may add new events to the list while it is being iterated over, by calling addFacesEvent(). If no events have been queued, an empty Iterator must be returned. + jakarta.faces.context + FacesContext + + + + + 1690 + Return the HttpSession instance for the session associated with the current request (if any); otherwise, return null. + jakarta.faces.context + FacesContext + + + + + 1691 + Return the Locale to be used in localizing the response being created for this FacesContext. + jakarta.faces.context + FacesContext + + + + + 1692 + Return the maximum severity level recorded on any Messages that has been queued, whether or not they are associated with any specific UIComponent. If no such messages have been queued, return a value less than Message.SEVERITY_INFO. + jakarta.faces.context + FacesContext + + + + + 1694 + Return an Iterator over the Messages that have been queued that are associated with the specified UIComponent, (if component is not null), or over the Messages that have been queued that are not associated with any specific UIComponent (if component is null). If no such messages have been queued, return an empty Iterator. + jakarta.faces.context + FacesContext + + + jakarta.faces.component.UIComponent + + + + + + 1697 + Return the ServletContext object for the web application associated with this request. + jakarta.faces.context + FacesContext + + + + + 1698 + Return the ServletRequest object representing the current request that is being processed. + jakarta.faces.context + FacesContext + + + + + 1699 + Return the ServletResponse object representing the current response that is being rendered. + jakarta.faces.context + FacesContext + + + + + 1700 + Return the component Tree that is associated with the this request. + jakarta.faces.context + FacesContext + + + + + 1704 + Set the Locale to be used in localizing the response being created for this FacesContext. If not set, the default Locale for our servlet container will be used. + jakarta.faces.context + FacesContext + + + java.util.Locale + + + + + + 1706 + if responseStream is null + jakarta.faces.context + FacesContext + + + jakarta.faces.context.ResponseStream + + java.lang.NullPointerException + + + + + 1708 + if responseWriter is null + jakarta.faces.context + FacesContext + + + jakarta.faces.context.ResponseWriter + + java.lang.NullPointerException + + + + + 1709 + Set the component Tree that is associated with this request. This method can only be called by the application handler (or a class that the handler calls), and only during the Invoke Application phase of the request processing lifecycle. + jakarta.faces.context + FacesContext + + + jakarta.faces.tree.Tree + + + + + + 1710 + if this method is called more than once without a call to release() in beween + jakarta.faces.context + FacesContext + + + jakarta.faces.tree.Tree + + java.lang.IllegalStateException + + + + + 1711 + if tree is null + jakarta.faces.context + FacesContext + + + jakarta.faces.tree.Tree + + java.lang.NullPointerException + + + + + 1713 + Create (if needed) and return a FacesContext instance that is initialized for the processing of the specified request and response objects, utilizing the specified Lifecycle instance, for this web application. + jakarta.faces.context + FacesContextFactory + + + ServletContext + ServletRequest + ServletResponse + jakarta.faces.lifecycle.Lifecycle + + + + + + 1714 + if a FacesContext cannot be constructed for the specified parameters + jakarta.faces.context + FacesContextFactory + + + ServletContext + ServletRequest + ServletResponse + jakarta.faces.lifecycle.Lifecycle + + jakarta.faces.FacesException + + + + + 1715 + if any of the parameters are null + jakarta.faces.context + FacesContextFactory + + + ServletContext + ServletRequest + ServletResponse + jakarta.faces.lifecycle.Lifecycle + + java.lang.NullPointerException + + + + + 1716 + Return the localized detail text for this Message (if any). This should be additional text that can help the user understand the context of the problem, and offer suggestions for approaches to correcting it. + jakarta.faces.context + Message + + + + + 1717 + Return the severity level of this Message. + jakarta.faces.context + Message + + + + + 1718 + Return the localized summary text for this Message. This should be the text that would normally be displayed to a user to identify the problem that needs to be corrected. + jakarta.faces.context + Message + + + + + 1719 + Return the localized detail text for this Message (if any). This should be additional text that can help the user understand the context of the problem, and offer suggestions for approaches to correcting it. + jakarta.faces.context + MessageImpl + + + + + 1720 + Return the severity level of this Message. + jakarta.faces.context + MessageImpl + + + + + 1721 + Return the localized summary text for this Message. This should be the text that would normally be displayed to a user to identify the problem that needs to be corrected. + jakarta.faces.context + MessageImpl + + + + + 1722 + Construct a new Message with no initial values. + jakarta.faces.context + MessageImpl + + + + + 1723 + Construct a new Message with the specified initial values. + jakarta.faces.context + MessageImpl + + + int + java.lang.String + java.lang.String + + + + + + 1724 + Set the localized detail text. + jakarta.faces.context + MessageImpl + + + java.lang.String + + + + + + 1725 + Set the severity level. + jakarta.faces.context + MessageImpl + + + int + + + + + + 1726 + if the specified severity level is not one of the supported values + jakarta.faces.context + MessageImpl + + + int + + java.lang.IllegalArgumentException + + + + + 1727 + Set the localized summary text. + jakarta.faces.context + MessageImpl + + + java.lang.String + + + + + + 1728 + Return a localized Message instance corresponding to the specified parameters, or null if the specified message identifier is not supported by the MessageResources instance. + jakarta.faces.context + MessageResources + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + 1729 + if context or messageId is null + jakarta.faces.context + MessageResources + + + jakarta.faces.context.FacesContext + java.lang.String + + java.lang.NullPointerException + + + + + 1730 + Return a localized Message instance corresponding to the specified parameters, or null if the specified message identifier is not supported by the MessageResources instance. + jakarta.faces.context + MessageResources + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.Object[] + + + + + + 1731 + if context or messageId is null + jakarta.faces.context + MessageResources + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.Object[] + + java.lang.NullPointerException + + + + + 1732 + Return a localized Message instance corresponding to the specified parameters, or null if the specified message identifier is not supported by the MessageResources instance. + jakarta.faces.context + MessageResources + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.Object + + + + + + 1733 + if context or messageId is null + jakarta.faces.context + MessageResources + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 1734 + Return a localized Message instance corresponding to the specified parameters, or null if the specified message identifier is not supported by the MessageResources instance. + jakarta.faces.context + MessageResources + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.Object + java.lang.Object + + + + + + 1735 + if context or messageId is null + jakarta.faces.context + MessageResources + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.Object + java.lang.Object + + java.lang.NullPointerException + + + + + 1736 + Return a localized Message instance corresponding to the specified parameters, or null if the specified message identifier is not supported by the MessageResources instance. + jakarta.faces.context + MessageResources + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.Object + java.lang.Object + java.lang.Object + + + + + + 1737 + if context or messageId is null + jakarta.faces.context + MessageResources + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.Object + java.lang.Object + java.lang.Object + + java.lang.NullPointerException + + + + + 1738 + Return a localized Message instance corresponding to the specified parameters, or null if the specified message identifier is not supported by the MessageResources instance. + jakarta.faces.context + MessageResources + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.Object + java.lang.Object + java.lang.Object + java.lang.Object + + + + + + 1739 + if context or messageId is null + jakarta.faces.context + MessageResources + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.Object + java.lang.Object + java.lang.Object + java.lang.Object + + java.lang.NullPointerException + + + + + 1740 + + jakarta.faces.context + MessageResources + + + + + 1741 + Register a new MessageResources instance, associated with the specified messageResourcesId, to be supported by this MessageResourcesFactory. This method may be called at any time, and makes the corresponding MessageResources instance available throughout the remaining lifetime of this web application. + jakarta.faces.context + MessageResourcesFactory + + + java.lang.String + jakarta.faces.context.MessageResources + + + + + + 1742 + if messageResourcesId is already registered in this MessageResourcesFactory + jakarta.faces.context + MessageResourcesFactory + + + java.lang.String + jakarta.faces.context.MessageResources + + java.lang.IllegalArgumentException + + + + + 1743 + if messageResourcesId or messageResources is null + jakarta.faces.context + MessageResourcesFactory + + + java.lang.String + jakarta.faces.context.MessageResources + + java.lang.NullPointerException + + + + + 1744 + Create (if needed) and return a MessageResources instance for the specified message resources identifier. The set of available message resources identifiers is available via the getMessageResourcesIds() method. Each call to getMessageResources() for the same messageResourcesId, from within the same web application, must return the same MessageResources instance. + jakarta.faces.context + MessageResourcesFactory + + + java.lang.String + + + + + + 1745 + if no MessageResources instance can be returned for the specified identifier + jakarta.faces.context + MessageResourcesFactory + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1746 + if messageResourcesId is null + jakarta.faces.context + MessageResourcesFactory + + + java.lang.String + + java.lang.NullPointerException + + + + + 1747 + Return an Iterator over the set of message resource identifiers supported by this factory. This Iterator must include the standard identifiers described above. + jakarta.faces.context + MessageResourcesFactory + + + + + 1748 + + jakarta.faces.context + MessageResourcesFactory + + + + + 1750 + + jakarta.faces.context + ResponseStream.{java.io.OutputStream} + + + + + 1751 + + jakarta.faces.context + ResponseStream.{java.io.OutputStream} + + java.io.IOException + + + + + 1752 + + jakarta.faces.context + ResponseStream.{java.io.OutputStream} + + + + + 1753 + + jakarta.faces.context + ResponseStream.{java.io.OutputStream} + + java.io.IOException + + + + + 1754 + + jakarta.faces.context + ResponseStream.{java.io.OutputStream} + + + int + + + + + + 1755 + + jakarta.faces.context + ResponseStream.{java.io.OutputStream} + + + int + + java.io.IOException + + + + + 1756 + + jakarta.faces.context + ResponseStream.{java.io.OutputStream} + + + byte[] + + + + + + 1757 + + jakarta.faces.context + ResponseStream.{java.io.OutputStream} + + + byte[] + + java.io.IOException + + + + + 1758 + + jakarta.faces.context + ResponseStream.{java.io.OutputStream} + + + byte[] + int + int + + + + + + 1759 + + jakarta.faces.context + ResponseStream.{java.io.OutputStream} + + + byte[] + int + int + + java.io.IOException + + + + + 1764 + if name is null + jakarta.faces.context + ResponseWriter + + + java.lang.String + + java.lang.NullPointerException + + + + + 1768 + Write the start of an element, up to and including the element name. Once this method has been called, clients can call writeAttribute() or writeURIAttribute() method to add attributes and corresponding values. The starting element will be closed (that is, the trailing '>' character added) on any subsequent call to startElement(), writeComment(), writeText(), endElement(), or endDocument(). + jakarta.faces.context + ResponseWriter + + + java.lang.String + + + + + + 1769 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + + java.lang.String + + java.io.IOException + + + + + 1770 + if name is null + jakarta.faces.context + ResponseWriter + + + java.lang.String + + java.lang.NullPointerException + + + + + 1771 + Write an attribute name and corresponding value (after converting that text to a String if necessary), after escaping it properly. This method may only be called after a call to startElement(), and before the opened element has been closed. + jakarta.faces.context + ResponseWriter + + + java.lang.String + java.lang.Object + + + + + + 1772 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + + java.lang.String + java.lang.Object + + java.io.IOException + + + + + 1773 + if this method is called when there is no currently open element + jakarta.faces.context + ResponseWriter + + + java.lang.String + java.lang.Object + + java.lang.IllegalStateException + + + + + 1774 + if name or value is null + jakarta.faces.context + ResponseWriter + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 1777 + if comment is null + jakarta.faces.context + ResponseWriter + + + java.lang.Object + + java.lang.NullPointerException + + + + + 1778 + Write an object (after converting it to a String, if necessary), after escaping it properly. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.context + ResponseWriter + + + java.lang.Object + + + + + + 1779 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + + java.lang.Object + + java.io.IOException + + + + + 1780 + if text is null + jakarta.faces.context + ResponseWriter + + + java.lang.Object + + java.lang.NullPointerException + + + + + 1781 + Write a single character, after escaping it properly. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.context + ResponseWriter + + + char + + + + + + 1782 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + + char + + java.io.IOException + + + + + 1783 + Write text from a character array, after escaping it properly. This is equivalent to calling writeText(c, 0, c.length). If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.context + ResponseWriter + + + char[] + + + + + + 1784 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + + char[] + + java.io.IOException + + + + + 1785 + if text is null + jakarta.faces.context + ResponseWriter + + + char[] + + java.lang.NullPointerException + + + + + 1788 + if the calculated starting or ending position is outside the bounds of the character array + jakarta.faces.context + ResponseWriter + + + char[] + int + int + + java.lang.IndexOutOfBoundsException + + + + + 1789 + if text is null + jakarta.faces.context + ResponseWriter + + + char[] + int + int + + java.lang.NullPointerException + + + + + 1790 + Write a URI attribute name and corresponding value (after converting that text to a String if necessary), after encoding it properly (for example, '%' encoded for HTML). This method may only be called after a call to startElement(), and before the opened element has been closed. + jakarta.faces.context + ResponseWriter + + + java.lang.String + java.lang.Object + + + + + + 1791 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + + java.lang.String + java.lang.Object + + java.io.IOException + + + + + 1792 + if this method is called when there is no currently open element + jakarta.faces.context + ResponseWriter + + + java.lang.String + java.lang.Object + + java.lang.IllegalStateException + + + + + 1793 + if name or value is null + jakarta.faces.context + ResponseWriter + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 1794 + + jakarta.faces.context + ResponseWriter.{java.io.Writer} + + + + + 1795 + + jakarta.faces.context + ResponseWriter.{java.io.Writer} + + java.io.IOException + + + + + 1796 + + jakarta.faces.context + ResponseWriter.{java.io.Writer} + + + + + 1797 + + jakarta.faces.context + ResponseWriter.{java.io.Writer} + + java.io.IOException + + + + + 1798 + + jakarta.faces.context + ResponseWriter.{java.io.Writer} + + + int + + + + + + 1799 + + jakarta.faces.context + ResponseWriter.{java.io.Writer} + + + int + + java.io.IOException + + + + + 1800 + + jakarta.faces.context + ResponseWriter.{java.io.Writer} + + + char[] + + + + + + 1801 + + jakarta.faces.context + ResponseWriter.{java.io.Writer} + + + char[] + + java.io.IOException + + + + + 1802 + + jakarta.faces.context + ResponseWriter.{java.io.Writer} + + + char[] + int + int + + + + + + 1803 + + jakarta.faces.context + ResponseWriter.{java.io.Writer} + + + char[] + int + int + + java.io.IOException + + + + + 1804 + + jakarta.faces.context + ResponseWriter.{java.io.Writer} + + + java.lang.String + + + + + + 1805 + + jakarta.faces.context + ResponseWriter.{java.io.Writer} + + + java.lang.String + + java.io.IOException + + + + + 1806 + + jakarta.faces.context + ResponseWriter.{java.io.Writer} + + + java.lang.String + int + int + + + + + + 1807 + + jakarta.faces.context + ResponseWriter.{java.io.Writer} + + + java.lang.String + int + int + + java.io.IOException + + + + + 1809 + if conversion cannot be successfully performed + jakarta.faces.convert + Converter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + jakarta.faces.convert.ConverterException + + + + + 1810 + if context or component is null + jakarta.faces.convert + Converter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + java.lang.NullPointerException + + + + + 1812 + if conversion cannot be successfully performed + jakarta.faces.convert + Converter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + jakarta.faces.convert.ConverterException + + + + + 1813 + if context or component is null + jakarta.faces.convert + Converter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + java.lang.NullPointerException + + + + + 1818 + Return the cause of this exception, or null if the cause is nonexistent or unknown. + jakarta.faces.convert + ConverterException.{jakarta.faces.FacesException} + + + + + 1819 + Register a new Converter instance with the specified converterId, to be supported by this ConverterFactory. This method may be called at any time, and makes the corresponding Converter instance available throughout the remaining lifetime of this web application. + jakarta.faces.convert + ConverterFactory + + + java.lang.String + jakarta.faces.convert.Converter + + + + + + 1820 + if a Converter with the specified converterId has already been registered + jakarta.faces.convert + ConverterFactory + + + java.lang.String + jakarta.faces.convert.Converter + + java.lang.IllegalArgumentException + + + + + 1821 + if converterId or converter is null + jakarta.faces.convert + ConverterFactory + + + java.lang.String + jakarta.faces.convert.Converter + + java.lang.NullPointerException + + + + + 1822 + Register a new Converter instance that knows how to perform conversions to and from the specified object class. This method may be called at any time, and makes the corresponding Converter instance available throughout the remaining lifetime of this web application. + jakarta.faces.convert + ConverterFactory + + + java.lang.Class + jakarta.faces.convert.Converter + + + + + + 1823 + if clazz or converter is null + jakarta.faces.convert + ConverterFactory + + + java.lang.Class + jakarta.faces.convert.Converter + + java.lang.NullPointerException + + + + + 1824 + + jakarta.faces.convert + ConverterFactory + + + + + 1825 + Create (if needed) and return a Converter instance that may be used to perform Object-to-String and String-to-Object conversions for objects of the specified class. A search of the registered Converters is performed in the following order: An exact match on the original class. An exact match on one of the interfaces directly implemented by the original class, checked in the order they are returned by Class.getInterfaces(). Recursively for each superclass of the original class: An exact match on this superclass. An exact match on one of the interfaces directly implemented by this superclass. If a Converter is discovered during the search described above, it is returned; otherwise null is returned. Each call to getConverter() for the same clazz, from within the same web application, must return the same Converter instance. + jakarta.faces.convert + ConverterFactory + + + java.lang.Class + + + + + + 1826 + if clazz is null + jakarta.faces.convert + ConverterFactory + + + java.lang.Class + + java.lang.NullPointerException + + + + + 1827 + Create (if needed) and return a Converter instance that may be used to perform Object-to-String and String-to-Object conversions for web applications based on JavaServer Faces. The set of available converter identifiers is available via the getConverterIds() method. If no Converter has been registered for the specified converter identifier, return null. Each call to getConverter() for the same converterId, from within the same web application, must return the same Converter instance. + jakarta.faces.convert + ConverterFactory + + + java.lang.String + + + + + + 1828 + if converterId is null + jakarta.faces.convert + ConverterFactory + + + java.lang.String + + java.lang.NullPointerException + + + + + 1829 + Return an Iterator over the set of classes for which we have registered Converters in this factory. + jakarta.faces.convert + ConverterFactory + + + + + 1830 + Return an Iterator over the set of converter identifiers supported by this factory. + jakarta.faces.convert + ConverterFactory + + + + + 1831 + Construct a new exception with no detail message or root cause. + jakarta.faces.el + EvaluationException + + + + + 1832 + Construct a new exception with the specified detail message and no root cause. + jakarta.faces.el + EvaluationException + + + java.lang.String + + + + + + 1833 + Construct a new exception with the specified root cause. The detail message will be set to (cause == null ? null : cause.toString() + jakarta.faces.el + EvaluationException + + + java.lang.Throwable + + + + + + 1834 + Construct a new exception with the specified detail message and root cause. + jakarta.faces.el + EvaluationException + + + java.lang.String + java.lang.Throwable + + + + + + 1835 + Return the cause of this exception, or null if the cause is nonexistent or unknown. + jakarta.faces.el + EvaluationException.{jakarta.faces.FacesException} + + + + + 1836 + Construct a new exception with no detail message or root cause. + jakarta.faces.el + PropertyNotFoundException + + + + + 1837 + Construct a new exception with the specified detail message and no root cause. + jakarta.faces.el + PropertyNotFoundException + + + java.lang.String + + + + + + 1838 + Construct a new exception with the specified root cause. The detail message will be set to (cause == null ? null : cause.toString() + jakarta.faces.el + PropertyNotFoundException + + + java.lang.Throwable + + + + + + 1839 + Construct a new exception with the specified detail message and root cause. + jakarta.faces.el + PropertyNotFoundException + + + java.lang.String + java.lang.Throwable + + + + + + 1840 + Return the cause of this exception, or null if the cause is nonexistent or unknown. + jakarta.faces.el + PropertyNotFoundException.{jakarta.faces.FacesException} + + + + + 1841 + Return the java.lang.Class representing the type of the specified property of the specified base object, if it can be determined; otherwise return null. + jakarta.faces.el + PropertyResolver + + + java.lang.Object + java.lang.String + + + + + + 1842 + if the specified property name does not exist + jakarta.faces.el + PropertyResolver + + + java.lang.Object + java.lang.String + + jakarta.faces.el.PropertyNotFoundException + + + + + 1843 + if base or name is null + jakarta.faces.el + PropertyResolver + + + java.lang.Object + java.lang.String + + java.lang.NullPointerException + + + + + 1844 + Return the java.lang.Class representing the type of value at the specified index of the specified base object, or null if this value is null. + jakarta.faces.el + PropertyResolver + + + java.lang.Object + int + + + + + + 1845 + if some other exception occurs + jakarta.faces.el + PropertyResolver + + + java.lang.Object + int + + jakarta.faces.el.PropertyNotFoundException + + + + + 1846 + if thrown by the underlying accessed to the indexed property + jakarta.faces.el + PropertyResolver + + + java.lang.Object + int + + java.lang.IndexOutOfBoundsException + + + + + 1847 + if base is null + jakarta.faces.el + PropertyResolver + + + java.lang.Object + int + + java.lang.NullPointerException + + + + + 1848 + Return the value of the property with the specified name from the specified base object. + jakarta.faces.el + PropertyResolver + + + java.lang.Object + java.lang.String + + + + + + 1849 + if the specified property name does not exist, or is not readable + jakarta.faces.el + PropertyResolver + + + java.lang.Object + java.lang.String + + jakarta.faces.el.PropertyNotFoundException + + + + + 1850 + if base or name is null + jakarta.faces.el + PropertyResolver + + + java.lang.Object + java.lang.String + + java.lang.NullPointerException + + + + + 1851 + Return the value at the specified index of the specified base object. + jakarta.faces.el + PropertyResolver + + + java.lang.Object + int + + + + + + 1852 + if some other exception occurs + jakarta.faces.el + PropertyResolver + + + java.lang.Object + int + + jakarta.faces.el.PropertyNotFoundException + + + + + 1853 + if thrown by the underlying access to the base object + jakarta.faces.el + PropertyResolver + + + java.lang.Object + int + + java.lang.IndexOutOfBoundsException + + + + + 1854 + if base is null + jakarta.faces.el + PropertyResolver + + + java.lang.Object + int + + java.lang.NullPointerException + + + + + 1855 + Return true if the specified property of the specified base object is known to be immutable; otherwise, return false. + jakarta.faces.el + PropertyResolver + + + java.lang.Object + java.lang.String + + + + + + 1856 + if the specified property name does not exist + jakarta.faces.el + PropertyResolver + + + java.lang.Object + java.lang.String + + jakarta.faces.el.PropertyNotFoundException + + + + + 1857 + if base or name is null + jakarta.faces.el + PropertyResolver + + + java.lang.Object + java.lang.String + + java.lang.NullPointerException + + + + + 1858 + Return true if the value at the specified index of the specified base object is known to be immutable; otherwise, return false. + jakarta.faces.el + PropertyResolver + + + java.lang.Object + int + + + + + + 1859 + if some other exception occurs + jakarta.faces.el + PropertyResolver + + + java.lang.Object + int + + jakarta.faces.el.PropertyNotFoundException + + + + + 1860 + if thrown by the underlying accessed to the indexed property + jakarta.faces.el + PropertyResolver + + + java.lang.Object + int + + java.lang.IndexOutOfBoundsException + + + + + 1861 + if base is null + jakarta.faces.el + PropertyResolver + + + java.lang.Object + int + + java.lang.NullPointerException + + + + + 1862 + + jakarta.faces.el + PropertyResolver + + + + + 1863 + Set the specified value of the property with the specified name on the specified base object. + jakarta.faces.el + PropertyResolver + + + java.lang.Object + java.lang.String + java.lang.Object + + + + + + 1864 + if the specified property name does not exist, or is not writeable + jakarta.faces.el + PropertyResolver + + + java.lang.Object + java.lang.String + java.lang.Object + + jakarta.faces.el.PropertyNotFoundException + + + + + 1865 + if base or name is null + jakarta.faces.el + PropertyResolver + + + java.lang.Object + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 1866 + Set the value at the specified index of the specified base object. + jakarta.faces.el + PropertyResolver + + + java.lang.Object + int + java.lang.Object + + + + + + 1867 + if some other exception occurs + jakarta.faces.el + PropertyResolver + + + java.lang.Object + int + java.lang.Object + + jakarta.faces.el.PropertyNotFoundException + + + + + 1868 + if thrown by the underlying access to the base object + jakarta.faces.el + PropertyResolver + + + java.lang.Object + int + java.lang.Object + + java.lang.IndexOutOfBoundsException + + + + + 1869 + if base is null + jakarta.faces.el + PropertyResolver + + + java.lang.Object + int + java.lang.Object + + java.lang.NullPointerException + + + + + 1870 + Construct a new exception with no detail message or root cause. + jakarta.faces.el + ReferenceSyntaxException + + + + + 1871 + Construct a new exception with the specified detail message and no root cause. + jakarta.faces.el + ReferenceSyntaxException + + + java.lang.String + + + + + + 1872 + Construct a new exception with the specified root cause. The detail message will be set to (cause == null ? null : cause.toString() + jakarta.faces.el + ReferenceSyntaxException + + + java.lang.Throwable + + + + + + 1873 + Construct a new exception with the specified detail message and root cause. + jakarta.faces.el + ReferenceSyntaxException + + + java.lang.String + java.lang.Throwable + + + + + + 1874 + Return the cause of this exception, or null if the cause is nonexistent or unknown. + jakarta.faces.el + ReferenceSyntaxException.{jakarta.faces.FacesException} + + + + + 1875 + Return the type of the property represented by this ValueBinding, relative to the specified FacesContext. + jakarta.faces.el + ValueBinding + + + jakarta.faces.context.FacesContext + + + + + + 1876 + if the specified property name does not exist, or is not writeable + jakarta.faces.el + ValueBinding + + + jakarta.faces.context.FacesContext + + jakarta.faces.el.PropertyNotFoundException + + + + + 1877 + if context is null + jakarta.faces.el + ValueBinding + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1878 + Return the value of the property represented by this ValueBinding, relative to the specified FacesContext. + jakarta.faces.el + ValueBinding + + + jakarta.faces.context.FacesContext + + + + + + 1879 + if the specified property name does not exist, or is not readable + jakarta.faces.el + ValueBinding + + + jakarta.faces.context.FacesContext + + jakarta.faces.el.PropertyNotFoundException + + + + + 1880 + if context is null + jakarta.faces.el + ValueBinding + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1881 + Return true if the specified property of the specified property is known to be immutable; otherwise, return false. + jakarta.faces.el + ValueBinding + + + jakarta.faces.context.FacesContext + + + + + + 1882 + if the specified property name does not exist + jakarta.faces.el + ValueBinding + + + jakarta.faces.context.FacesContext + + jakarta.faces.el.PropertyNotFoundException + + + + + 1883 + if context is null + jakarta.faces.el + ValueBinding + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1884 + Set the value of the property represented by this ValueBinding, relative to the specified FacesContext. + jakarta.faces.el + ValueBinding + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + 1885 + if the specified property name does not exist, or is not writeable + jakarta.faces.el + ValueBinding + + + jakarta.faces.context.FacesContext + java.lang.Object + + jakarta.faces.el.PropertyNotFoundException + + + + + 1886 + if context is null + jakarta.faces.el + ValueBinding + + + jakarta.faces.context.FacesContext + java.lang.Object + + java.lang.NullPointerException + + + + + 1887 + + jakarta.faces.el + ValueBinding + + + + + 1888 + Resolve the specified variable name, and return the corresponding object, if any; otherwise, return null. + jakarta.faces.el + VariableResolver + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + 1889 + if context or name is null + jakarta.faces.el + VariableResolver + + + jakarta.faces.context.FacesContext + java.lang.String + + java.lang.NullPointerException + + + + + 1890 + + jakarta.faces.el + VariableResolver + + + + + 1892 + Return the cause of this exception, or null if the cause is nonexistent or unknown. + jakarta.faces.event + AbortProcessingException.{jakarta.faces.FacesException} + + + + + 1893 + Construct a new event object from the specified source component and action command. + jakarta.faces.event + ActionEvent + + + jakarta.faces.component.UIComponent + java.lang.String + + + + + + 1894 + Return the String identifying the command that was activated. + jakarta.faces.event + ActionEvent + + + + + 1895 + Return the source UIComponent that sent this event. + jakarta.faces.event + ActionEvent.{jakarta.faces.event.FacesEvent} + + + + + 1898 + Return the identifier of the request processing phase during which this listener is interested in processing events of the type we are supporting. Legal values are the singleton instances defined by the PhaseId class. FacesListener instances should generally return PhaseId.ANY_PHASE to be notified about events no matter what the current request processing phase is. + jakarta.faces.event + ActionListener.{jakarta.faces.event.FacesListener} + + + + + 1901 + Return the identifier of the request processing phase during which this listener is interested in processing events of the type we are supporting. Legal values are the singleton instances defined by the PhaseId class. FacesListener instances should generally return PhaseId.ANY_PHASE to be notified about events no matter what the current request processing phase is. + jakarta.faces.event + FacesListener + + + + + 1905 + Return the current local value of the source UIComponent. + jakarta.faces.event + ValueChangedEvent + + + + + 1906 + Return the previous local value of the source UIComponent. + jakarta.faces.event + ValueChangedEvent + + + + + 1907 + Construct a new event object from the specified source component, old value, and new value. + jakarta.faces.event + ValueChangedEvent + + + jakarta.faces.component.UIComponent + java.lang.Object + java.lang.Object + + + + + + 1908 + Return the source UIComponent that sent this event. + jakarta.faces.event + ValueChangedEvent.{jakarta.faces.event.FacesEvent} + + + + + 1909 + Invoked when the value change described by the specified ValueChangedEvent occurs. + jakarta.faces.event + ValueChangedListener + + + jakarta.faces.event.ValueChangedEvent + + + + + + 1910 + Signal the JavaServer Faces implementation that no further processing on the current event should be performed + jakarta.faces.event + ValueChangedListener + + + jakarta.faces.event.ValueChangedEvent + + jakarta.faces.event.AbortProcessingException + + + + + 1911 + Return the identifier of the request processing phase during which this listener is interested in processing events of the type we are supporting. Legal values are the singleton instances defined by the PhaseId class. FacesListener instances should generally return PhaseId.ANY_PHASE to be notified about events no matter what the current request processing phase is. + jakarta.faces.event + ValueChangedListener.{jakarta.faces.event.FacesListener} + + + + + 1914 + if context is null + jakarta.faces.lifecycle + Lifecycle + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1915 + Return the ViewHandler instance that will be utilized during the Render Response phase of the request processing lifecycle. + jakarta.faces.lifecycle + Lifecycle + + + + + 1917 + Set the ViewHandler instance that will be utilized during the Render Response phase of the request processing lifecycle. + jakarta.faces.lifecycle + Lifecycle + + + jakarta.faces.lifecycle.ViewHandler + + + + + + 1918 + if this method is called after at least one request has been processed by this Lifecycle instance + jakarta.faces.lifecycle + Lifecycle + + + jakarta.faces.lifecycle.ViewHandler + + java.lang.IllegalStateException + + + + + 1919 + if handler is null + jakarta.faces.lifecycle + Lifecycle + + + jakarta.faces.lifecycle.ViewHandler + + java.lang.NullPointerException + + + + + 1921 + if a Lifecycle with the specified lifecycleId has already been registered + jakarta.faces.lifecycle + LifecycleFactory + + + java.lang.String + jakarta.faces.lifecycle.Lifecycle + + java.lang.IllegalArgumentException + + + + + 1922 + if lifecycleId or lifecycle is null + jakarta.faces.lifecycle + LifecycleFactory + + + java.lang.String + jakarta.faces.lifecycle.Lifecycle + + java.lang.NullPointerException + + + + + 1924 + if no Lifecycle instance can be returned for the specified identifier + jakarta.faces.lifecycle + LifecycleFactory + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1925 + if lifecycleId is null + jakarta.faces.lifecycle + LifecycleFactory + + + java.lang.String + + java.lang.NullPointerException + + + + + 1928 + Perform whatever actions are required to render the response component tree to the ServletResponse associated with the specified FacesContext. + jakarta.faces.lifecycle + ViewHandler + + + jakarta.faces.context.FacesContext + + + + + + 1929 + if an input/output error occurs + jakarta.faces.lifecycle + ViewHandler + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + 1930 + if a servlet error occurs + jakarta.faces.lifecycle + ViewHandler + + + jakarta.faces.context.FacesContext + + ServletException + + + + + 1931 + if context is null + jakarta.faces.lifecycle + ViewHandler + + + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1933 + if an input/output error occurs while decoding + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.io.IOException + + + + + 1934 + if context or component is null + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1937 + if context or component is null + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1940 + if context or component is null + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1943 + if context or component is null + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1944 + Return an AttributeDescriptor for the specified attribute name, as supported for the specified component class. + jakarta.faces.render + Renderer + + + jakarta.faces.component.UIComponent + java.lang.String + + + + + + 1945 + if the specified component class is not supported + jakarta.faces.render + Renderer + + + jakarta.faces.component.UIComponent + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1946 + if the specified attribute name is not supported for the specified component class + jakarta.faces.render + Renderer + + + jakarta.faces.component.UIComponent + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1947 + if component or name is null + jakarta.faces.render + Renderer + + + jakarta.faces.component.UIComponent + java.lang.String + + java.lang.NullPointerException + + + + + 1948 + Return an AttributeDescriptor for the specified attribute name, as supported for the specified component type. + jakarta.faces.render + Renderer + + + java.lang.String + java.lang.String + + + + + + 1949 + if the specified component type is not supported + jakarta.faces.render + Renderer + + + java.lang.String + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1950 + if the specified attribute name is not supported for the specified component type + jakarta.faces.render + Renderer + + + java.lang.String + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1951 + if type or name is null + jakarta.faces.render + Renderer + + + java.lang.String + java.lang.String + + java.lang.NullPointerException + + + + + 1952 + Return an Iterator over the names of the supported attributes for the specified UIComponent implementation class. If no attributes are supported, an empty Iterator is returned. + jakarta.faces.render + Renderer + + + jakarta.faces.component.UIComponent + + + + + + 1953 + if the specified component class is not supported + jakarta.faces.render + Renderer + + + jakarta.faces.component.UIComponent + + java.lang.IllegalArgumentException + + + + + 1954 + if component is null + jakarta.faces.render + Renderer + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1955 + Return an Iterator over the names of the supported attributes for the specified component type. If no attributes are supported, an empty Iterator is returned. + jakarta.faces.render + Renderer + + + java.lang.String + + + + + + 1956 + if the specified component type is not supported + jakarta.faces.render + Renderer + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1957 + if type is null + jakarta.faces.render + Renderer + + + java.lang.String + + java.lang.NullPointerException + + + + + 1958 + Generate and return a new client-side identifier for the specified component. + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + 1959 + if context or component is null + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1961 + Return true if this Renderer supports components of the specified UIComponent class. + jakarta.faces.render + Renderer + + + jakarta.faces.component.UIComponent + + + + + + 1962 + if component is null + jakarta.faces.render + Renderer + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1963 + Return true if this Renderer supports components of the specified type. This is matched against the type property of each UIComponent to determine compatibility. + jakarta.faces.render + Renderer + + + java.lang.String + + + + + + 1964 + if componentType is null + jakarta.faces.render + Renderer + + + java.lang.String + + java.lang.NullPointerException + + + + + 1965 + Add a new UIComponent subclass to the set of component classes registered with this RenderKit instance and supported by its constituent Renderers. + jakarta.faces.render + RenderKit + + + java.lang.Class + + + + + + 1966 + if componentClass is not a UIComponent subclass + jakarta.faces.render + RenderKit + + + java.lang.Class + + java.lang.IllegalArgumentException + + + + + 1967 + if componentClass is null + jakarta.faces.render + RenderKit + + + java.lang.Class + + java.lang.NullPointerException + + + + + 1968 + Add a new Renderer instance, associated with the specified rendererType, to the set of Renderers registered with this RenderKit. + jakarta.faces.render + RenderKit + + + java.lang.String + jakarta.faces.render.Renderer + + + + + + 1969 + if a Renderer with the specified rendererType has already been registered + jakarta.faces.render + RenderKit + + + java.lang.String + jakarta.faces.render.Renderer + + java.lang.IllegalArgumentException + + + + + 1970 + if rendererType or renderer is null + jakarta.faces.render + RenderKit + + + java.lang.String + jakarta.faces.render.Renderer + + java.lang.NullPointerException + + + + + 1971 + Return an Iterator of the UIComponent classes that are registered with this RenderKit instance and supported by its constituent Renderers. If there are no such registered component classes, an empty Iterator is returned. + jakarta.faces.render + RenderKit + + + + + 1972 + Create (if necessary) and return a Renderer instance with the specified renderer type. Subsequent calls to this method with the same rendererType, from the same web application, must return the same instance. + jakarta.faces.render + RenderKit + + + java.lang.String + + + + + + 1973 + if the requested renderer type is not supported by this RenderKit + jakarta.faces.render + RenderKit + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1974 + if rendererType is null + jakarta.faces.render + RenderKit + + + java.lang.String + + java.lang.NullPointerException + + + + + 1975 + Return an Iterator of all the renderer types registered with this RenderKit. + jakarta.faces.render + RenderKit + + + + + 1977 + if componentType is null + jakarta.faces.render + RenderKit + + + java.lang.String + + java.lang.NullPointerException + + + + + 1978 + Return an Iterator of the renderer types of all Renderer instances registered with this RenderKit that support components of the specified UIComponent subclass. If no Renderers support this component class, an empty Iterator is returned. + jakarta.faces.render + RenderKit + + + jakarta.faces.component.UIComponent + + + + + + 1979 + if component is null + jakarta.faces.render + RenderKit + + + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 1982 + if a RenderKit with the specified renderKitId has already been registered + jakarta.faces.render + RenderKitFactory + + + java.lang.String + jakarta.faces.render.RenderKit + + java.lang.IllegalArgumentException + + + + + 1983 + if renderKitId or renderKit is null + jakarta.faces.render + RenderKitFactory + + + java.lang.String + jakarta.faces.render.RenderKit + + java.lang.NullPointerException + + + + + 1984 + Create (if needed) and return a RenderKit instance for the specified render kit identifier. The set of available render kit identifiers is available via the getRenderKitIds() method. Each call to getRenderKit() for the same renderKitId, from within the same web application, must return the same RenderKit instance. + jakarta.faces.render + RenderKitFactory + + + java.lang.String + + + + + + 1985 + if no RenderKit instance can be returned for the specified identifier + jakarta.faces.render + RenderKitFactory + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 1986 + if renderKitId is null + jakarta.faces.render + RenderKitFactory + + + java.lang.String + + java.lang.NullPointerException + + + + + 1987 + Create (if needed) and return a RenderKit instance for the specified render kit identifier, possibly customized based on dynamic characteristics of the specified FacesContext. The set of available render kit identifiers is available via the getRenderKitIds() method. + jakarta.faces.render + RenderKitFactory + + + java.lang.String + jakarta.faces.context.FacesContext + + + + + + 1988 + if no RenderKit instance can be returned for the specified identifier + jakarta.faces.render + RenderKitFactory + + + java.lang.String + jakarta.faces.context.FacesContext + + java.lang.IllegalArgumentException + + + + + 1989 + if renderKitId or context is null + jakarta.faces.render + RenderKitFactory + + + java.lang.String + jakarta.faces.context.FacesContext + + java.lang.NullPointerException + + + + + 1992 + Return the render kit identifier of the RenderKit instance (if any) associated with this Tree. + jakarta.faces.tree + Tree + + + + + 1993 + Return the root node of the component tree associated with this Tree. + jakarta.faces.tree + Tree + + + + + 1994 + Return the tree identifier for this Tree. + jakarta.faces.tree + Tree + + + + + 1995 + Set the render kit identifier of the RenderKit instance (if any) associated with this Tree. + jakarta.faces.tree + Tree + + + java.lang.String + + + + + + 1996 + + jakarta.faces.tree + Tree + + + + + 1997 + Create (if needed) and return a Tree that is initialized with a root node, and whose renderKitId property is initialized to the identifier of the default jakarta.faces.render.RenderKit. + jakarta.faces.tree + TreeFactory + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + 1998 + if a Tree cannot be constructed for the specified parameters + jakarta.faces.tree + TreeFactory + + + jakarta.faces.context.FacesContext + java.lang.String + + jakarta.faces.FacesException + + + + + 1999 + if context or treeId is null + jakarta.faces.tree + TreeFactory + + + jakarta.faces.context.FacesContext + java.lang.String + + java.lang.NullPointerException + + + + + 2000 + + jakarta.faces.tree + TreeFactory + + + + + 2006 + Return a flag indicating whether a maximum limit has been set. + jakarta.faces.validator + DoubleRangeValidator + + + + + 2007 + Return a flag indicating whether a minimum limit has been set. + jakarta.faces.validator + DoubleRangeValidator + + + + + 2009 + if a specified maximum value is less than a specified minimum value + jakarta.faces.validator + DoubleRangeValidator + + + double + + java.lang.IllegalArgumentException + + + + + 2011 + if a specified maximum value is less than a specified minimum value + jakarta.faces.validator + DoubleRangeValidator + + + double + + java.lang.IllegalArgumentException + + + + + 2012 + Perform the correctness checks implemented by this Validator against the specified UIComponent. If any violations are found: Add zero or more Messages to the specified FacesContext, specifying this UIComponent as associated with the message, describing the nature of the violation(s) encountered. Set the valid property on the specified UIComponent to false. + jakarta.faces.validator + DoubleRangeValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + 2013 + if context or component is null + jakarta.faces.validator + DoubleRangeValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 2016 + Return a flag indicating whether a maximum length has been set. + jakarta.faces.validator + LengthValidator + + + + + 2017 + Return a flag indicating whether a minimum limit has been set. + jakarta.faces.validator + LengthValidator + + + + + 2022 + if a specified maximum value is less than a specified minimum value + jakarta.faces.validator + LengthValidator + + + int + + java.lang.IllegalArgumentException + + + + + 2024 + if a specified maximum value is less than a specified minimum value + jakarta.faces.validator + LengthValidator + + + int + + java.lang.IllegalArgumentException + + + + + 2025 + Perform the correctness checks implemented by this Validator against the specified UIComponent. If any violations are found: Add zero or more Messages to the specified FacesContext, specifying this UIComponent as associated with the message, describing the nature of the violation(s) encountered. Set the valid property on the specified UIComponent to false. + jakarta.faces.validator + LengthValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + 2026 + if context or component is null + jakarta.faces.validator + LengthValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 2029 + Return a flag indicating whether a maximum limit has been set. + jakarta.faces.validator + LongRangeValidator + + + + + 2030 + Return a flag indicating whether a minimum limit has been set. + jakarta.faces.validator + LongRangeValidator + + + + + 2035 + if a specified maximum value is less than a specified minimum value + jakarta.faces.validator + LongRangeValidator + + + long + + java.lang.IllegalArgumentException + + + + + 2037 + if a specified maximum value is less than a specified minimum value + jakarta.faces.validator + LongRangeValidator + + + long + + java.lang.IllegalArgumentException + + + + + 2038 + Perform the correctness checks implemented by this Validator against the specified UIComponent. If any violations are found: Add zero or more Messages to the specified FacesContext, specifying this UIComponent as associated with the message, describing the nature of the violation(s) encountered. Set the valid property on the specified UIComponent to false. + jakarta.faces.validator + LongRangeValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + 2039 + if context or component is null + jakarta.faces.validator + LongRangeValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 2041 + Perform the correctness checks implemented by this Validator against the specified UIComponent. If any violations are found: Add zero or more Messages to the specified FacesContext, specifying this UIComponent as associated with the message, describing the nature of the violation(s) encountered. Set the valid property on the specified UIComponent to false. + jakarta.faces.validator + RequiredValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + 2042 + if context or component is null + jakarta.faces.validator + RequiredValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 2043 + Return the maximum value to be enforced by this Validator, if isMaximumSet() returns true. + jakarta.faces.validator + StringRangeValidator + + + + + 2044 + Return the minimum value to be enforced by this Validator, if isMinimumSet() returns true. + jakarta.faces.validator + StringRangeValidator + + + + + 2045 + Return a flag indicating whether a maximum limit has been set. + jakarta.faces.validator + StringRangeValidator + + + + + 2046 + Return a flag indicating whether a minimum limit has been set. + jakarta.faces.validator + StringRangeValidator + + + + + 2047 + Set the maximum value to be enforced by this Validator. + jakarta.faces.validator + StringRangeValidator + + + java.lang.String + + + + + + 2048 + if a specified maximum value is less than a specified minimum value + jakarta.faces.validator + StringRangeValidator + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 2049 + if maximum is null + jakarta.faces.validator + StringRangeValidator + + + java.lang.String + + java.lang.NullPointerException + + + + + 2050 + Set the minimum value to be enforced by this Validator. + jakarta.faces.validator + StringRangeValidator + + + java.lang.String + + + + + + 2051 + if a specified maximum value is less than a specified minimum value + jakarta.faces.validator + StringRangeValidator + + + java.lang.String + + java.lang.IllegalArgumentException + + + + + 2052 + if minimum is null + jakarta.faces.validator + StringRangeValidator + + + java.lang.String + + java.lang.NullPointerException + + + + + 2053 + Construct a Validator with no preconfigured limits. + jakarta.faces.validator + StringRangeValidator + + + + + 2054 + Construct a Validator with the specified preconfigured limit. + jakarta.faces.validator + StringRangeValidator + + + java.lang.String + + + + + + 2055 + Construct a Validator with the specified preconfigured limits. + jakarta.faces.validator + StringRangeValidator + + + java.lang.String + java.lang.String + + + + + + 2056 + Perform the correctness checks implemented by this Validator against the specified UIComponent. If any violations are found: Add zero or more Messages to the specified FacesContext, specifying this UIComponent as associated with the message, describing the nature of the violation(s) encountered. Set the valid property on the specified UIComponent to false. + jakarta.faces.validator + StringRangeValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + 2057 + if context or component is null + jakarta.faces.validator + StringRangeValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 2058 + Perform the correctness checks implemented by this Validator against the specified UIComponent. If any violations are found: Add zero or more Messages to the specified FacesContext, specifying this UIComponent as associated with the message, describing the nature of the violation(s) encountered. Set the valid property on the specified UIComponent to false. + jakarta.faces.validator + Validator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + 2059 + if context or component is null + jakarta.faces.validator + Validator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.lang.NullPointerException + + + + + 2060 + + jakarta.faces.webapp + AttributeTag + + + + + 2061 + Register the specified attribute name and value with the UIComponent instance associated with our most immediately surrounding FacesTag instance, if this UIComponent does not already have a value for the specified attribute name. + jakarta.faces.webapp + AttributeTag + + + + + 2062 + if a JSP error occurs + jakarta.faces.webapp + AttributeTag + + JspException + + + + + 2063 + Release references to any acquired resources. + jakarta.faces.webapp + AttributeTag + + + + + 2064 + Set the attribute name. + jakarta.faces.webapp + AttributeTag + + + java.lang.String + + + + + + 2065 + Set the attribute value. + jakarta.faces.webapp + AttributeTag + + + java.lang.String + + + + + + 2066 + Handle the ending of the nested body content for this tag. The default implementation simply calls getDoAfterBodyValue() to retrieve the flag value to be returned. + jakarta.faces.webapp + FacesBodyTag + + + + + 2067 + if an error is encountered + jakarta.faces.webapp + FacesBodyTag + + JspException + + + + + 2068 + Prepare for evaluation of the body. This method is invoked by the JSP page implementation object after setBodyContent() and before the first time the body is to be evaluated. This method will not be invoked for empty tags or for non-empty tags whose doStartTag() method returns SKIP_BODY or EVAL_BODY_INCLUDE. + jakarta.faces.webapp + FacesBodyTag + + + + + 2069 + if an error is encountered + jakarta.faces.webapp + FacesBodyTag + + JspException + + + + + 2070 + + jakarta.faces.webapp + FacesBodyTag + + + + + 2071 + Return the BodyContent for this tag handler. + jakarta.faces.webapp + FacesBodyTag + + + + + 2072 + Get the JspWriter from our BodyContent. + jakarta.faces.webapp + FacesBodyTag + + + + + 2073 + Release any resources allocated during the execution of this tag handler. + jakarta.faces.webapp + FacesBodyTag + + + + + 2074 + Set the bodyContent for this tag handler. This method is invoked by the JSP page implementation object at most once per action invocation, before doInitiBody(). This method will not be invoked for empty tags or for non-empty tags whose doStartTag() method returns SKIP_BODY or EVAL_BODY_INCLUDE. + jakarta.faces.webapp + FacesBodyTag + + + BodyContent + + + + + + 2075 + Render the ending of the UIComponent that is associated with this tag (via the id attribute), by following these steps. If the rendersChildren property of this component is true, call the encodeChildren() method of the component. Call the encodeEnd() method of the component. Release all references to the component, and pop it from the component stack for this response, removing the stack if this was the outermost component. The flag value to be returned is acquired by calling the getDoEndValue() method, which tag subclasses may override if they do not want the default value. + jakarta.faces.webapp + FacesBodyTag.{jakarta.faces.webapp.FacesTag} + + + + + 2076 + if an error occurs + jakarta.faces.webapp + FacesBodyTag.{jakarta.faces.webapp.FacesTag} + + JspException + + + + + 2077 + Render the beginning of the UIComponent that is associated with this tag (via the id attribute), by following these steps. Ensure that an appropriate ResponseWriter is associated with the current FacesContext. This ensures that encoded output from the components is routed through the JspWriter for the current page. Locate the component (in the component tree) corresponding to this tag, creating a new one if necesary. Override the attributes of the associated component with values set in our custom tag attributes, if values for the corresponding attributes are NOT already set on the component. Push this component onto the stack of components corresponding to nested component tags for the current response, creating the stack if necessary. Call the encodeBegin() method of the component. The flag value to be returned is acquired by calling the getDoStartValue() method, which tag subclasses may override if they do not want the default value. + jakarta.faces.webapp + FacesBodyTag.{jakarta.faces.webapp.FacesTag} + + + + + 2078 + if an error occurs + jakarta.faces.webapp + FacesBodyTag.{jakarta.faces.webapp.FacesTag} + + JspException + + + + + 2079 + Return the UIComponent instance that is associated with this tag instance. This method is designed to be used by tags nested within this tag, and only returns useful results between the execution of doStartTag() and doEndTag() on this tag instance. + jakarta.faces.webapp + FacesBodyTag.{jakarta.faces.webapp.FacesTag} + + + + + 2080 + Return true if we dynamically created a new component instance during execution of this tag. This method is designed to be used by tags nested within this tag, and only returns useful results between the execution of doStartTag() and doEndTag() on this tag instance. + jakarta.faces.webapp + FacesBodyTag.{jakarta.faces.webapp.FacesTag} + + + + + 2081 + Return the Tag that is the parent of this instance. + jakarta.faces.webapp + FacesBodyTag.{jakarta.faces.webapp.FacesTag} + + + + + 2082 + Return the rendererType property that selects the Renderer to be used for encoding this component, or null to ask the component to render itself directly. Subclasses must override this method to return the appropriate value. + jakarta.faces.webapp + FacesBodyTag.{jakarta.faces.webapp.FacesTag} + + + + + 2083 + Set the component identifier for our component. + jakarta.faces.webapp + FacesBodyTag.{jakarta.faces.webapp.FacesTag} + + + java.lang.String + + + + + + 2084 + Set the PageContext of the page containing this tag instance. + jakarta.faces.webapp + FacesBodyTag.{jakarta.faces.webapp.FacesTag} + + + PageContext + + + + + + 2085 + Set the Tag that is the parent of this instance. In addition, locate the closest enclosing FacesTag and increment its numChildren counter. Finally, save our childIndex as (enclosingFacesTag.numChildren - 1). + jakarta.faces.webapp + FacesBodyTag.{jakarta.faces.webapp.FacesTag} + + + Tag + + + + + + 2086 + Set an override for the rendered attribute. + jakarta.faces.webapp + FacesBodyTag.{jakarta.faces.webapp.FacesTag} + + + boolean + + + + + + 2089 + Return the ServletConfig instance for this servlet. + jakarta.faces.webapp + FacesServlet + + + + + 2091 + Acquire the factory instances we will require. + jakarta.faces.webapp + FacesServlet + + + ServletConfig + + + + + + 2092 + + jakarta.faces.webapp + FacesServlet + + + ServletConfig + + ServletException + + + + + 2093 + Process an incoming request, and create the corresponding response, by executing the request processing lifecycle. + jakarta.faces.webapp + FacesServlet + + + ServletRequest + ServletResponse + + + + + + 2094 + if an input/output error occurs during processing + jakarta.faces.webapp + FacesServlet + + + ServletRequest + ServletResponse + + java.io.IOException + + + + + 2095 + if a servlet error occurs during processing + jakarta.faces.webapp + FacesServlet + + + ServletRequest + ServletResponse + + ServletException + + + + + 2096 + Render the ending of the UIComponent that is associated with this tag (via the id attribute), by following these steps. If the rendersChildren property of this component is true, call the encodeChildren() method of the component. Call the encodeEnd() method of the component. Release all references to the component, and pop it from the component stack for this response, removing the stack if this was the outermost component. The flag value to be returned is acquired by calling the getDoEndValue() method, which tag subclasses may override if they do not want the default value. + jakarta.faces.webapp + FacesTag + + + + + 2097 + if an error occurs + jakarta.faces.webapp + FacesTag + + JspException + + + + + 2098 + Render the beginning of the UIComponent that is associated with this tag (via the id attribute), by following these steps. Ensure that an appropriate ResponseWriter is associated with the current FacesContext. This ensures that encoded output from the components is routed through the JspWriter for the current page. Locate the component (in the component tree) corresponding to this tag, creating a new one if necesary. Override the attributes of the associated component with values set in our custom tag attributes, if values for the corresponding attributes are NOT already set on the component. Push this component onto the stack of components corresponding to nested component tags for the current response, creating the stack if necessary. Call the encodeBegin() method of the component. The flag value to be returned is acquired by calling the getDoStartValue() method, which tag subclasses may override if they do not want the default value. + jakarta.faces.webapp + FacesTag + + + + + 2099 + if an error occurs + jakarta.faces.webapp + FacesTag + + JspException + + + + + 2100 + + jakarta.faces.webapp + FacesTag + + + + + 2101 + Return the UIComponent instance that is associated with this tag instance. This method is designed to be used by tags nested within this tag, and only returns useful results between the execution of doStartTag() and doEndTag() on this tag instance. + jakarta.faces.webapp + FacesTag + + + + + 2102 + Return true if we dynamically created a new component instance during execution of this tag. This method is designed to be used by tags nested within this tag, and only returns useful results between the execution of doStartTag() and doEndTag() on this tag instance. + jakarta.faces.webapp + FacesTag + + + + + 2103 + Return the Tag that is the parent of this instance. + jakarta.faces.webapp + FacesTag + + + + + 2104 + Return the rendererType property that selects the Renderer to be used for encoding this component, or null to ask the component to render itself directly. Subclasses must override this method to return the appropriate value. + jakarta.faces.webapp + FacesTag + + + + + 2105 + Release any resources allocated during the execution of this tag handler. + jakarta.faces.webapp + FacesTag + + + + + 2106 + Set the component identifier for our component. + jakarta.faces.webapp + FacesTag + + + java.lang.String + + + + + + 2107 + Set the PageContext of the page containing this tag instance. + jakarta.faces.webapp + FacesTag + + + PageContext + + + + + + 2108 + Set the Tag that is the parent of this instance. In addition, locate the closest enclosing FacesTag and increment its numChildren counter. Finally, save our childIndex as (enclosingFacesTag.numChildren - 1). + jakarta.faces.webapp + FacesTag + + + Tag + + + + + + 2109 + Set an override for the rendered attribute. + jakarta.faces.webapp + FacesTag + + + boolean + + + + + + 2110 + + jakarta.faces.webapp + FacetTag + + + + + 2111 + + jakarta.faces.webapp + FacetTag + + JspException + + + + + 2112 + + jakarta.faces.webapp + FacetTag + + + + + 2113 + + jakarta.faces.webapp + FacetTag + + JspException + + + + + 2114 + + jakarta.faces.webapp + FacetTag + + + + + 2115 + + jakarta.faces.webapp + FacetTag + + + + + 2116 + + jakarta.faces.webapp + FacetTag + + + + + 2117 + + jakarta.faces.webapp + FacetTag + + + java.lang.String + + + + + + 2118 + Close the underlying writer. + jakarta.faces.webapp + JspResponseWriter + + + + + 2119 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter + + java.io.IOException + + + + + 2120 + Flush the underlying writer's buffer, if any. + jakarta.faces.webapp + JspResponseWriter + + + + + 2121 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter + + java.io.IOException + + + + + 2122 + Create a JspResponseWriter that wraps the specified PageContext. + jakarta.faces.webapp + JspResponseWriter + + + PageContext + + + + + + 2123 + Write an array of characters. + jakarta.faces.webapp + JspResponseWriter + + + char[] + + + + + + 2124 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter + + + char[] + + java.io.IOException + + + + + 2125 + Write a portion of an array of characters. + jakarta.faces.webapp + JspResponseWriter + + + char[] + int + int + + + + + + 2126 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter + + + char[] + int + int + + java.io.IOException + + + + + 2127 + Write a single character from the low-order 16 bits of the specified integer. + jakarta.faces.webapp + JspResponseWriter + + + int + + + + + + 2128 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter + + + int + + java.io.IOException + + + + + 2129 + Write a String of characters. + jakarta.faces.webapp + JspResponseWriter + + + java.lang.String + + + + + + 2130 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter + + + java.lang.String + + java.io.IOException + + + + + 2131 + Write a portion of a String of characters. + jakarta.faces.webapp + JspResponseWriter + + + java.lang.String + int + int + + + + + + 2132 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter + + + java.lang.String + int + int + + java.io.IOException + + + + + 2133 + Write whatever text should end a response. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + + + 2134 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + java.io.IOException + + + + + 2135 + Write the end of an element, after closing any open element created by a call to startElement(). + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + + + + + + 2136 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + + java.io.IOException + + + + + 2137 + if name is null + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 2138 + Write whatever text should begin a response. + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + + + 2139 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + java.io.IOException + + + + + 2140 + Write the start of an element, up to and including the element name. Once this method has been called, clients can call writeAttribute() or writeURIAttribute() method to add attributes and corresponding values. The starting element will be closed (that is, the trailing '>' character added) on any subsequent call to startElement(), writeComment(), writeText(), endElement(), or endDocument(). + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + + + + + + 2141 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + + java.io.IOException + + + + + 2142 + if name is null + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 2143 + Write an attribute name and corresponding value (after converting that text to a String if necessary), after escaping it properly. This method may only be called after a call to startElement(), and before the opened element has been closed. + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + java.lang.Object + + + + + + 2144 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + java.lang.Object + + java.io.IOException + + + + + 2145 + if this method is called when there is no currently open element + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalStateException + + + + + 2146 + if name or value is null + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 2147 + Write a comment containing the specified text, after converting that text to a String if necessary. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.Object + + + + + + 2148 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.Object + + java.io.IOException + + + + + 2149 + if comment is null + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.Object + + java.lang.NullPointerException + + + + + 2150 + Write an object (after converting it to a String, if necessary), after escaping it properly. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.Object + + + + + + 2151 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.Object + + java.io.IOException + + + + + 2152 + if text is null + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.Object + + java.lang.NullPointerException + + + + + 2153 + Write a single character, after escaping it properly. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char + + + + + + 2154 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char + + java.io.IOException + + + + + 2155 + Write text from a character array, after escaping it properly. This is equivalent to calling writeText(c, 0, c.length). If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char[] + + + + + + 2156 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char[] + + java.io.IOException + + + + + 2157 + if text is null + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char[] + + java.lang.NullPointerException + + + + + 2158 + Write text from a character array, after escaping it properly for this method. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char[] + int + int + + + + + + 2159 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char[] + int + int + + java.io.IOException + + + + + 2160 + if the calculated starting or ending position is outside the bounds of the character array + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char[] + int + int + + java.lang.IndexOutOfBoundsException + + + + + 2161 + if text is null + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char[] + int + int + + java.lang.NullPointerException + + + + + 2162 + Write a URI attribute name and corresponding value (after converting that text to a String if necessary), after encoding it properly (for example, '%' encoded for HTML). This method may only be called after a call to startElement(), and before the opened element has been closed. + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + java.lang.Object + + + + + + 2163 + if an input/output error occurs + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + java.lang.Object + + java.io.IOException + + + + + 2164 + if this method is called when there is no currently open element + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalStateException + + + + + 2165 + if name or value is null + jakarta.faces.webapp + JspResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 2166 + Close the underlying writer. + jakarta.faces.webapp + ServletResponseWriter + + + + + 2167 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter + + java.io.IOException + + + + + 2168 + Flush the underlying writer's buffer, if any. + jakarta.faces.webapp + ServletResponseWriter + + + + + 2169 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter + + java.io.IOException + + + + + 2170 + Create a ServletResponseWriter that wraps the specified PrintWriter. + jakarta.faces.webapp + ServletResponseWriter + + + java.io.PrintWriter + + + + + + 2171 + Write an array of characters. + jakarta.faces.webapp + ServletResponseWriter + + + char[] + + + + + + 2172 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter + + + char[] + + java.io.IOException + + + + + 2173 + Write a portion of an array of characters. + jakarta.faces.webapp + ServletResponseWriter + + + char[] + int + int + + + + + + 2174 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter + + + char[] + int + int + + java.io.IOException + + + + + 2175 + Write a single character from the low-order 16 bits of the specified integer. + jakarta.faces.webapp + ServletResponseWriter + + + int + + + + + + 2176 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter + + + int + + java.io.IOException + + + + + 2177 + Write a String of characters. + jakarta.faces.webapp + ServletResponseWriter + + + java.lang.String + + + + + + 2178 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter + + + java.lang.String + + java.io.IOException + + + + + 2179 + Write a portion of a String of characters. + jakarta.faces.webapp + ServletResponseWriter + + + java.lang.String + int + int + + + + + + 2180 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter + + + java.lang.String + int + int + + java.io.IOException + + + + + 2181 + Write whatever text should end a response. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + + + 2182 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + java.io.IOException + + + + + 2183 + Write the end of an element, after closing any open element created by a call to startElement(). + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + + + + + + 2184 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + + java.io.IOException + + + + + 2185 + if name is null + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 2186 + Write whatever text should begin a response. + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + + + 2187 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + java.io.IOException + + + + + 2188 + Write the start of an element, up to and including the element name. Once this method has been called, clients can call writeAttribute() or writeURIAttribute() method to add attributes and corresponding values. The starting element will be closed (that is, the trailing '>' character added) on any subsequent call to startElement(), writeComment(), writeText(), endElement(), or endDocument(). + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + + + + + + 2189 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + + java.io.IOException + + + + + 2190 + if name is null + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + + java.lang.NullPointerException + + + + + 2191 + Write an attribute name and corresponding value (after converting that text to a String if necessary), after escaping it properly. This method may only be called after a call to startElement(), and before the opened element has been closed. + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + java.lang.Object + + + + + + 2192 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + java.lang.Object + + java.io.IOException + + + + + 2193 + if this method is called when there is no currently open element + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalStateException + + + + + 2194 + if name or value is null + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 2195 + Write a comment containing the specified text, after converting that text to a String if necessary. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.Object + + + + + + 2196 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.Object + + java.io.IOException + + + + + 2197 + if comment is null + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.Object + + java.lang.NullPointerException + + + + + 2198 + Write an object (after converting it to a String, if necessary), after escaping it properly. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.Object + + + + + + 2199 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.Object + + java.io.IOException + + + + + 2200 + if text is null + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.Object + + java.lang.NullPointerException + + + + + 2201 + Write a single character, after escaping it properly. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char + + + + + + 2202 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char + + java.io.IOException + + + + + 2203 + Write text from a character array, after escaping it properly. This is equivalent to calling writeText(c, 0, c.length). If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char[] + + + + + + 2204 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char[] + + java.io.IOException + + + + + 2205 + if text is null + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char[] + + java.lang.NullPointerException + + + + + 2206 + Write text from a character array, after escaping it properly for this method. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char[] + int + int + + + + + + 2207 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char[] + int + int + + java.io.IOException + + + + + 2208 + if the calculated starting or ending position is outside the bounds of the character array + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char[] + int + int + + java.lang.IndexOutOfBoundsException + + + + + 2209 + if text is null + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + char[] + int + int + + java.lang.NullPointerException + + + + + 2210 + Write a URI attribute name and corresponding value (after converting that text to a String if necessary), after encoding it properly (for example, '%' encoded for HTML). This method may only be called after a call to startElement(), and before the opened element has been closed. + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + java.lang.Object + + + + + + 2211 + if an input/output error occurs + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + java.lang.Object + + java.io.IOException + + + + + 2212 + if this method is called when there is no currently open element + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + java.lang.Object + + java.lang.IllegalStateException + + + + + 2213 + if name or value is null + jakarta.faces.webapp + ServletResponseWriter.{jakarta.faces.webapp.ResponseWriterBase} + + + java.lang.String + java.lang.Object + + java.lang.NullPointerException + + + + + 2214 + Create a new instance of the specified Validator class, and register it with the UIComponent instance associated with our most immediately surrounding FacesTag instance, if the UIComponent instance was created by this execution of the containing JSP page. + jakarta.faces.webapp + ValidatorTag + + + + + 2215 + if a JSP error occurs + jakarta.faces.webapp + ValidatorTag + + JspException + + + + + 2216 + Release references to any acquired resources. + jakarta.faces.webapp + ValidatorTag + + + + + 2217 + Set the fully qualified class name of the Validator instance to be created. + jakarta.faces.webapp + ValidatorTag + + + java.lang.String + + + + + + 2218 + + jakarta.faces.webapp + ValidatorTag + + + + + + + + JSF:JAVADOC:2219 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces + FacesWrapper + + + + + JSF:JAVADOC:2220 + This method will store the argument factoryName/implName mapping in such a way that #getFactory will find this mapping when searching for a match. This method has no effect if getFactory() has already been called looking for a factory for this factoryName. This method can be used by implementations to store a factory mapping while parsing the Faces configuration file + jakarta.faces + FactoryFinder + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2221 + + jakarta.faces.annotation + ApplicationMap.Literal + + + + + JSF:JAVADOC:2222 + The value of this attribute indicates that features corresponding to this version must be enabled for this application. + jakarta.faces.annotation + FacesConfig + + + + + JSF:JAVADOC:2223 + + jakarta.faces.annotation + FacesConfig.Literal + + + + + JSF:JAVADOC:2224 + The value of this attribute indicates that features corresponding to this version must be enabled for this application. + jakarta.faces.annotation + FacesConfig.Literal + + + + + JSF:JAVADOC:2225 + + jakarta.faces.annotation + FacesConfig.Version + + + java.lang.String + + + + + + JSF:JAVADOC:2226 + + jakarta.faces.annotation + FacesConfig.Version + + + + + JSF:JAVADOC:2227 + + jakarta.faces.annotation + FlowMap.Literal + + + + + JSF:JAVADOC:2228 + + jakarta.faces.annotation + HeaderMap.Literal + + + + + JSF:JAVADOC:2229 + + jakarta.faces.annotation + HeaderValuesMap.Literal + + + + + JSF:JAVADOC:2230 + + jakarta.faces.annotation + InitParameterMap.Literal + + + + + JSF:JAVADOC:2231 + Taken to be the value that is injected into the field. + jakarta.faces.annotation + ManagedProperty + + + + + JSF:JAVADOC:2232 + + jakarta.faces.annotation + ManagedProperty.Literal + + + java.lang.String + + + + + + JSF:JAVADOC:2233 + Taken to be the value that is injected into the field. + jakarta.faces.annotation + ManagedProperty.Literal + + + + + JSF:JAVADOC:2234 + + jakarta.faces.annotation + RequestCookieMap.Literal + + + + + JSF:JAVADOC:2235 + + jakarta.faces.annotation + RequestMap.Literal + + + + + JSF:JAVADOC:2236 + + jakarta.faces.annotation + RequestParameterMap.Literal + + + + + JSF:JAVADOC:2237 + + jakarta.faces.annotation + RequestParameterValuesMap.Literal + + + + + JSF:JAVADOC:2238 + + jakarta.faces.annotation + SessionMap.Literal + + + + + JSF:JAVADOC:2239 + Set the Faces View Id pattern. The Faces View Id pattern can represent a single view, such as "/index.xhtml", or a pattern like "/foo/bar/*". Though the exact interpretation of the Faces View Id for a single view is ultimately defined by the annotated element, in general it should align with the return value from an action expression (see ActionSource2#setActionExpression(jakarta.el.MethodExpression) + jakarta.faces.annotation + View + + + + + JSF:JAVADOC:2240 + + jakarta.faces.annotation + View.Literal + + + java.lang.String + + + + + + JSF:JAVADOC:2241 + Set the Faces View Id pattern. The Faces View Id pattern can represent a single view, such as "/index.xhtml", or a pattern like "/foo/bar/*". Though the exact interpretation of the Faces View Id for a single view is ultimately defined by the annotated element, in general it should align with the return value from an action expression (see ActionSource2#setActionExpression(jakarta.el.MethodExpression) + jakarta.faces.annotation + View.Literal + + + + + JSF:JAVADOC:2242 + + jakarta.faces.annotation + ViewMap.Literal + + + + + JSF:JAVADOC:2243 + Register a new mapping of behavior id to the name of the corresponding Behavior class. This allows subsequent calls to createBehavior() to serve as a factory for Behavior instances. + jakarta.faces.application + Application + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2244 + Register a new mapping of component type to the name of the corresponding UIComponent class. This allows subsequent calls to createComponent() to serve as a factory for UIComponent instances. + jakarta.faces.application + Application + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2245 + Register a new mapping of converter id to the name of the corresponding Converter class. This allows subsequent calls to createConverter() to serve as a factory for Converter instances. + jakarta.faces.application + Application + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2246 + Register a new converter class that is capable of performing conversions for the specified target class. + jakarta.faces.application + Application + + + java.lang.Class + java.lang.String + + + + + + JSF:JAVADOC:2247 + Register a validator by its id that is applied to all UIInput components in a view. The validator to most often serve this role is the BeanValidator. The usage contract for this method assumes that the validator has been registered using the normal #8220;by-id #8221; registration mechanism. An implementation is provided that takes no action so that users that decorate the Application continue to work. + jakarta.faces.application + Application + + + java.lang.String + + + + + + JSF:JAVADOC:2248 + Provide a way for Faces applications to register an ELContextListener that will be notified on creation of ELContext instances. This listener will be called once per request. An implementation is provided that throws UnsupportedOperationException so that users that decorate the Application continue to work. + jakarta.faces.application + Application + + + jakarta.el.ELContextListener + + + + + + JSF:JAVADOC:2249 + Cause an the argument resolver to be added to the resolver chain as specified in section 5.3.2 "ELResolver" of the Jakarta Faces Specification Document. It is not possible to remove an ELResolver registered with this method, once it has been registered. It is illegal to register an ELResolver after the application has received any requests from the client. If an attempt is made to register a listener after that time, an IllegalStateException must be thrown. This restriction is in place to allow the Jakarta Server Pages container to optimize for the common case where no additional ELResolvers are in the chain, aside from the standard ones. It is permissible to add ELResolvers before or after initialization to a CompositeELResolver that is already in the chain. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend Application. + jakarta.faces.application + Application + + + jakarta.el.ELResolver + + + + + + JSF:JAVADOC:2250 + Cause the argument resolver to be added to the head of the resolver chain. It is not possible to remove a SearchKeywordResolver registered with this method, once it has been registered. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend Application. + jakarta.faces.application + Application + + + jakarta.faces.component.search.SearchKeywordResolver + + + + + + JSF:JAVADOC:2251 + Register a new mapping of validator id to the name of the corresponding Validator class. This allows subsequent calls to createValidator() to serve as a factory for Validator instances. + jakarta.faces.application + Application + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2252 + Instantiate and return a new Behavior instance of the class specified by a previous call to addBehavior() for the specified behavior id. + jakarta.faces.application + Application + + + java.lang.String + + + + + + JSF:JAVADOC:2253 + if the Behavior cannot be created + jakarta.faces.application + Application + + + java.lang.String + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:2254 + Instantiate and return a new UIComponent instance of the class specified by a previous call to addComponent() for the specified component type. Before the component instance is returned, it must be inspected for the presence of a jakarta.faces.event.ListenerFor (or jakarta.faces.event.ListenersFor) or ResourceDependency (or ResourceDependencies) annotation. If any of these annotations are present, the action listed in jakarta.faces.event.ListenerFor or ResourceDependency must be taken on the component, before it is returned from this method. This variant of createComponent must not inspect the jakarta.faces.render.Renderer for the component to be returned for any of the afore mentioned annotations. Such inspection is the province of #createComponent(ValueExpression, FacesContext, String, String) or #createComponent(FacesContext, String, String). + jakarta.faces.application + Application + + + java.lang.String + + + + + + JSF:JAVADOC:2255 + if a UIComponent of the specified type cannot be created + jakarta.faces.application + Application + + + java.lang.String + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:2256 + Call the getValue() method on the specified ValueExpression. If it returns a UIComponent instance, return it as the value of this method. If it does not, instantiate a new UIComponent instance of the specified component type, pass the new component to the setValue() method of the specified ValueExpression, and return it. Before the component instance is returned, it must be inspected for the presence of a jakarta.faces.event.ListenerFor (or jakarta.faces.event.ListenersFor) or ResourceDependency (or ResourceDependencies) annotation. If any of these annotations are present, the action listed in jakarta.faces.event.ListenerFor or ResourceDependency must be taken on the component, before it is returned from this method. This variant of createComponent must not inspect the jakarta.faces.render.Renderer for the component to be returned for any of the afore mentioned annotations. Such inspection is the province of #createComponent(ValueExpression, FacesContext, String, String) or #createComponent(FacesContext, String, String). A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function. + jakarta.faces.application + Application + + + jakarta.el.ValueExpression + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2257 + if a UIComponent cannot be created + jakarta.faces.application + Application + + + jakarta.el.ValueExpression + jakarta.faces.context.FacesContext + java.lang.String + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:2258 + Like #createComponent(ValueExpression, FacesContext, String) except the Renderer for the component to be returned must be inspected for the annotations mentioned in #createComponent(ValueExpression, FacesContext, String) as specified in the documentation for that method. The Renderer instance to inspect must be obtained by calling FacesContext#getRenderKit and calling jakarta.faces.render.RenderKit#getRenderer on the result, passing the argument componentType as the first argument and the result of calling UIComponent#getFamily on the newly created component as the second argument. If no such Renderer can be found, a message must be logged with a helpful error message. Otherwise, UIComponent#setRendererType must be called on the newly created UIComponent instance, passing the argument rendererType as the argument. A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function. + jakarta.faces.application + Application + + + jakarta.el.ValueExpression + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2259 + Like #createComponent(String) except the Renderer for the component to be returned must be inspected for the annotations mentioned in #createComponent(ValueExpression, FacesContext, String) as specified in the documentation for that method. The Renderer instance to inspect must be obtained by calling FacesContext#getRenderKit and calling jakarta.faces.render.RenderKit#getRenderer on the result, passing the argument componentType as the first argument and the result of calling UIComponent#getFamily on the newly created component as the second argument. If no such Renderer can be found, a message must be logged with a helpful error message. Otherwise, UIComponent#setRendererType must be called on the newly created UIComponent instance, passing the argument rendererType as the argument. A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function . + jakarta.faces.application + Application + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2260 + Instantiate and return a new UIComponent instance from the argument Resource. An algorithm semantically equivalent to the following must be followed to instantiate the UIComponent to return. Obtain a reference to the ViewDeclarationLanguage for this Application instance by calling ViewHandler#getViewDeclarationLanguage, passing the viewId found by calling jakarta.faces.component.UIViewRoot#getViewId on the jakarta.faces.component.UIViewRoot in the argument FacesContext. Obtain a reference to the composite component metadata for this composite component by calling ViewDeclarationLanguage#getComponentMetadata, passing the facesContext and componentResource arguments to this method. This version of the Jakarta Faces Specification uses JavaBeans as the API to the component metadata. Determine if the component author declared a componentType for this component instance by obtaining the BeanDescriptor from the component metadata and calling its getValue() method, passing UIComponent#COMPOSITE_COMPONENT_TYPE_KEY as the argument. If non-null, the result must be a ValueExpression whose value is the component-type of the UIComponent to be created for this Resource component. Call through to #createComponent(java.lang.String) to create the component. Otherwise, determine if a script based component for this Resource can be found by calling ViewDeclarationLanguage#getScriptComponentResource. If the result is non-null, and is a script written in a language satisfying the content type text/javascript, create a UIComponent instance from the script resource. Otherwise, let library-name be the return from calling Resource#getLibraryName on the argument componentResource and resource-name be the return from calling Resource#getResourceName on the argument componentResource. Create a fully qualified Java class name by removing any file extension from resource-name and let fqcn be library-name + "." + resource-name. If a class with the name of fqcn cannot be found, take no action and continue to the next step. If any of InstantiationException, IllegalAccessException, or ClassCastException are thrown, wrap the exception in a FacesException and re-throw it. If any other exception is thrown, log the exception and continue to the next step. If none of the previous steps have yielded a UIComponent instance, call #createComponent(java.lang.String) passing "jakarta.faces.NamingContainer" as the argument. Call UIComponent#setRendererType on the UIComponent instance, passing "jakarta.faces.Composite" as the argument. Store the argument Resource in the attributes Map of the UIComponent under the key, Resource#COMPONENT_RESOURCE_KEY. Store composite component metadata in the attributes Map of the UIComponent under the key, UIComponent#BEANINFO_KEY. Before the component instance is returned, it must be inspected for the presence of a jakarta.faces.event.ListenerFor annotation. If this annotation is present, the action listed in jakarta.faces.event.ListenerFor must be taken on the component, before it is returned from this method. A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function. + jakarta.faces.application + Application + + + jakarta.faces.context.FacesContext + jakarta.faces.application.Resource + + + + + + JSF:JAVADOC:2261 + Instantiate and return a new Converter instance of the class specified by a previous call to addConverter() for the specified converter id. If the toLowerCase() of the String represenation of the value of the "jakarta.faces.DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE" application configuration parameter is "true" (without the quotes) and the Converter instance to be returned is an instance of jakarta.faces.convert.DateTimeConverter, jakarta.faces.convert.DateTimeConverter#setTimeZone must be called, passing the return from TimeZone.getDefault(). The argument converter must be inspected for the presence of the jakarta.faces.application.ResourceDependency annotation. If the ResourceDependency annotation is present, the action described in ResourceDependency must be taken. If the ResourceDependency annotation is not present, the argument converter must be inspected for the presence of the jakarta.faces.application.ResourceDependencies annotation. If the ResourceDependencies annotation is present, the action described in ResourceDependencies must be taken. + jakarta.faces.application + Application + + + java.lang.String + + + + + + JSF:JAVADOC:2262 + Instantiate and return a new Converter instance of the class that has registered itself as capable of performing conversions for objects of the specified type. If no such Converter class can be identified, return null. To locate an appropriate Converter class, the following algorithm is performed, stopping as soon as an appropriate Converter class is found: Locate a Converter registered for the target class itself. Locate a Converter registered for interfaces that are implemented by the target class (directly or indirectly). Locate a Converter registered for the superclass (if any) of the target class, recursively working up the inheritance hierarchy. If the Converter has a single argument constructor that accepts a Class, instantiate the Converter using that constructor, passing the argument targetClass as the sole argument. Otherwise, simply use the zero-argument constructor. If the toLowerCase() of the String represenation of the value of the "jakarta.faces.DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE" application configuration parameter is "true" (without the quotes) and the Converter instance to be returned is an instance of jakarta.faces.convert.DateTimeConverter, jakarta.faces.convert.DateTimeConverter#setTimeZone must be called, passing the return from TimeZone.getDefault(). + jakarta.faces.application + Application + + + java.lang.Class + + + + + + JSF:JAVADOC:2263 + Instantiate and return a new Validator instance of the class specified by a previous call to addValidator() for the specified validator id. The argument validator must be inspected for the presence of the jakarta.faces.application.ResourceDependency annotation. If the ResourceDependency annotation is present, the action described in ResourceDependency must be taken. If the ResourceDependency annotation is not present, the argument validator must be inspected for the presence of the jakarta.faces.application.ResourceDependencies annotation. If the ResourceDependencies annotation is present, the action described in ResourceDependencies must be taken. + jakarta.faces.application + Application + + + java.lang.String + + + + + + JSF:JAVADOC:2264 + if a Validator of the specified id cannot be created + jakarta.faces.application + Application + + + java.lang.String + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:2265 + Get a value by evaluating an expression. Call #getExpressionFactory then call ExpressionFactory#createValueExpression passing the argument expression and expectedType. Call FacesContext#getELContext and pass it to ValueExpression#getValue, returning the result. An implementation is provided that throws UnsupportedOperationException so that users that decorate the Application continue to work. + jakarta.faces.application + Application + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.Class + + + + + + JSF:JAVADOC:2266 + + jakarta.faces.application + Application + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.Class + + jakarta.el.ELException + + + + + JSF:JAVADOC:2267 + Return an Iterator over the set of currently registered behavior ids for this Application. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2268 + Return an Iterator over the set of currently defined component types for this Application. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2269 + Return an Iterator over the set of currently registered converter ids for this Application. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2270 + Return an Iterator over the set of Class instances for which Converter classes have been explicitly registered. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2271 + Return the default Locale for this application. If not explicitly set, null is returned. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2272 + Return the renderKitId to be used for rendering this application. If not explicitly set, null is returned. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2273 + Return an immutable Map over the set of currently registered default validator IDs and their class name for this Application. An implementation is provided that returns Collections.emptyMap so that users that decorate the Application continue to work. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2274 + If no calls have been made to #addELContextListener, this method must return an empty array. Otherwise, return an array representing the list of listeners added by calls to #addELContextListener. An implementation is provided that throws UnsupportedOperationException so that users that decorate the Application continue to work. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2275 + Return the singleton ELResolver instance to be used for all Jakarta Expression Language resolution. This is actually an instance of jakarta.el.CompositeELResolver that must contain the following ELResolver instances in the following order: ELResolver instances declared using the element in the application configuration resources. An implementation that wraps the head of the legacy VariableResolver chain, as per section VariableResolver ChainWrapper in Chapter 5 in the spec document. An implementation that wraps the head of the legacy PropertyResolver chain, as per section PropertyResolver ChainWrapper in Chapter 5 in the spec document. Any ELResolver instances added by calls to #addELResolver. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend Application. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2276 + Return the ExpressionFactory instance for this application. This instance is used by the convenience method #evaluateExpressionGet. The implementation must return the ExpressionFactory from the Expression Language container by calling jakarta.el.ELManager.getExpressionFactory(). An implementation is provided that throws UnsupportedOperationException so that users that decorate the Application continue to work. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2277 + Return the thread-safe singleton FlowHandler for this application. For implementations declaring compliance with version 2.2 of the specification, this method must never return null, even if the application has no flows. This is necessary to enable dynamic flow creation during the application's lifetime. All implementations that declare compliance with version 2.2 of the specification must implement this method. For the purpose of backward compatibility with environments that extend Application but do not override this method, an implementation is provided that returns null. Due to the decoratable nature of Application, code calling this method should always check for a null return. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2278 + Return the fully qualified class name of the ResourceBundle to be used for Jakarta Faces messages for this application. If not explicitly set, null is returned. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2279 + Return the project stage for the currently running application instance. The default value is ProjectStage#Production The implementation of this method must perform the following algorithm or an equivalent with the same end result to determine the value to return. If the value has already been determined by a previous call to this method, simply return that value. Look for a JNDI environment entry under the key given by the value of ProjectStage#PROJECT_STAGE_JNDI_NAME (return type of java.lang.String). If found, continue with the algorithm below, otherwise, look for an entry in the initParamMap of the ExternalContext from the current FacesContext with the key given by the value of ProjectStage#PROJECT_STAGE_PARAM_NAME If a value is found, see if an enum constant can be obtained by calling ProjectStage.valueOf(), passing the value from the initParamMap. If this succeeds without exception, save the value and return it. If not found, or any of the previous attempts to discover the enum constant value have failed, log a descriptive error message, assign the value as ProjectStage.Production and return it. A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function . + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2280 + Find a ResourceBundle as defined in the application configuration resources under the specified name. If a ResourceBundle was defined for the name, return an instance that uses the locale of the current jakarta.faces.component.UIViewRoot. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.application + Application + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2281 + Return the singleton, stateless, thread-safe ResourceHandler for this application. The Jakarta Faces implementation must support the following techniques for declaring an alternate implementation of ResourceHandler. The ResourceHandler implementation is declared in the application configuration resources by giving the fully qualified class name as the value of the element within the element. In all of the above cases, the runtime must employ the decorator pattern as for every other pluggable artifact in Jakarta Faces. A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function . + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2282 + Return the thread-safe singleton SearchExpressionHandler for this application. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2283 + Return the singleton SearchKeywordResolver instance to be used for all search keyword resolution. This is actually an instance of a composite SearchKeywordResolver that must contain the following SearchKeywordResolver instances in the following order: SearchKeywordResolver instances declared using the element in the application configuration resources. Any SearchKeywordResolver instances added by calls to #addSearchKeywordResolver. The SearchKeywordResolver implementations for @all, @child(n), @form, @id(...), @namingcontainer, @next, @none, @parent, @previous, @root and @this. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend Application. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2284 + Return the StateManager instance that will be utilized during the Restore View and Render Response phases of the request processing lifecycle. If not explicitly set, a default implementation must be provided that performs the functions described in the StateManager description in the Jakarta Faces Specification. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2285 + Return an Iterator over the supported Locales for this appication. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2286 + Return an Iterator over the set of currently registered validator ids for this Application. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2287 + Return the ViewHandler instance that will be utilized during the Restore View and Render Response phases of the request processing lifecycle. If not explicitly set, a default implementation must be provided that performs the functions described in the ViewHandler description in the Jakarta Faces Specification. + jakarta.faces.application + Application + + + + + JSF:JAVADOC:2288 + If jakarta.faces.context.FacesContext#isProcessingEvents() is true and there are one or more listeners for events of the type represented by systemEventClass, call those listeners, passing source as the source of the event. The implementation should be as fast as possible in determining whether or not a listener for the given systemEventClass and source has been installed, and should return immediately once such a determination has been made. The implementation of publishEvent must honor the requirements stated in #subscribeToEvent regarding the storage and retrieval of listener instances. Specifically, if #subscribeToEvent(Class,Class,SystemEventListener) was called, the sourceClass argument must match exactly the Class of the source argument in the call to publishEvent(). The implementation must not do any inheritance hierarachy inspection when looking for a match between the sourceClass passed to #subscribeToEvent(Class,Class,SystemEventListener) and the sourceClass passed to publishEvent() in order to find any listeners to which the event should be published. In the case where the Class of the source argument does not match the Class of the sourceClass used when the listener was subscribed using subscribeToEvent(), #publishEvent(FacesContext,Class,Class,Object) can be used to provide the Class used to perform the listener lookup and match. The default implementation must implement an algorithm semantically equivalent to the following to locate listener instances and to invoke them. If the source argument implements jakarta.faces.event.SystemEventListenerHolder, call jakarta.faces.event.SystemEventListenerHolder#getListenersForEventClass on it, passing the systemEventClass argument. If the list is not empty, perform algorithm traverseListenerList on the list. If any view level listeners have been installed by previous calls to #subscribeToEvent(Class, Class, jakarta.faces.event.SystemEventListener) on the jakarta.faces.component.UIViewRoot, perform algorithm traverseListenerList on the list of listeners for that event installed on the UIViewRoot. If any Application level listeners have been installed by previous calls to #subscribeToEvent(Class, Class, jakarta.faces.event.SystemEventListener), perform algorithm traverseListenerList on the list. If any Application level listeners have been installed by previous calls to #subscribeToEvent(Class, jakarta.faces.event.SystemEventListener), perform algorithm traverseListenerList on the list. If the act of invoking the processListener method causes an jakarta.faces.event.AbortProcessingException to be thrown, processing of the listeners must be aborted, no further processing of the listeners for this event must take place, and the exception must be logged with Level.SEVERE. Algorithm traverseListenerList: For each listener in the list, Call jakarta.faces.event.SystemEventListener#isListenerForSource, passing the source argument. If this returns false, take no action on the listener. Otherwise, if the event to be passed to the listener instances has not yet been constructed, construct the event, passing source as the argument to the one-argument constructor that takes an Object. This same event instance must be passed to all listener instances. Call jakarta.faces.event.SystemEvent#isAppropriateListener, passing the listener instance as the argument. If this returns false, take no action on the listener. Call jakarta.faces.event.SystemEvent#processListener, passing the listener instance. A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function . + jakarta.faces.application + Application + + + jakarta.faces.context.FacesContext + java.lang.Class + java.lang.Object + + + + + + JSF:JAVADOC:2289 + This method functions exactly like #publishEvent(FacesContext,Class,Object), except the run-time must use the argument sourceBaseType to find the matching listener instead of using the Class of the source argument. A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function . + jakarta.faces.application + Application + + + jakarta.faces.context.FacesContext + java.lang.Class + java.lang.Class + java.lang.Object + + + + + + JSF:JAVADOC:2290 + Remove the argument listener from the list of ELContextListeners. If listener is null, no exception is thrown and no action is performed. If listener is not in the list, no exception is thrown and no action is performed. An implementation is provided that throws UnsupportedOperationException so that users that decorate the Application continue to work. + jakarta.faces.application + Application + + + jakarta.el.ELContextListener + + + + + + JSF:JAVADOC:2291 + Set the default Locale for this application. + jakarta.faces.application + Application + + + java.util.Locale + + + + + + JSF:JAVADOC:2292 + Set the renderKitId to be used to render this application. Unless the client has provided a custom ViewHandler that supports the use of multiple jakarta.faces.render.RenderKit instances in the same application, this method must only be called at application startup, before any Faces requests have been processed. This is a limitation of the current Specification, and may be lifted in a future release. + jakarta.faces.application + Application + + + java.lang.String + + + + + + JSF:JAVADOC:2293 + Set the FlowHandler instance used by the NavigationHandler to satisfy the requirements of the faces flows feature. + jakarta.faces.application + Application + + + jakarta.faces.flow.FlowHandler + + + + + + JSF:JAVADOC:2294 + Set the fully qualified class name of the ResourceBundle to be used for Jakarta Faces messages for this application. See the JavaDocs for the java.util.ResourceBundle class for more information about the syntax for resource bundle names. + jakarta.faces.application + Application + + + java.lang.String + + + + + + JSF:JAVADOC:2295 + Set the ResourceHandler instance that will be utilized for rendering the markup for resources, and for satisfying client requests to serve up resources. + jakarta.faces.application + Application + + + jakarta.faces.application.ResourceHandler + + + + + + JSF:JAVADOC:2296 + Set the SearchExpressionHandler instance used by the application. + jakarta.faces.application + Application + + + jakarta.faces.component.search.SearchExpressionHandler + + + + + + JSF:JAVADOC:2297 + Set the StateManager instance that will be utilized during the Restore View and Render Response phases of the request processing lifecycle. + jakarta.faces.application + Application + + + jakarta.faces.application.StateManager + + + + + + JSF:JAVADOC:2298 + Set the Locale instances representing the supported Locales for this application. + jakarta.faces.application + Application + + + java.util.Collection + + + + + + JSF:JAVADOC:2299 + Set the ViewHandler instance that will be utilized during the Restore View and Render Response phases of the request processing lifecycle. + jakarta.faces.application + Application + + + jakarta.faces.application.ViewHandler + + + + + + JSF:JAVADOC:2300 + Install the listener instance referenced by argument listener into the application as a listener for events of type systemEventClass that originate from objects of type sourceClass. If argument sourceClass is non-null, sourceClass and systemEventClass must be used to store the argument listener in the application in such a way that the listener can be quickly looked up by the implementation of #publishEvent given systemEventClass and an instance of the Class referenced by sourceClass. If argument sourceClass is null, the listener must be discoverable by the implementation of #publishEvent given only systemEventClass. It is valid to call this method during the processing of an event which was subscribed to by a previous call to this method. + jakarta.faces.application + Application + + + java.lang.Class + java.lang.Class + jakarta.faces.event.SystemEventListener + + + + + + JSF:JAVADOC:2301 + Install the listener instance referenced by argument listener into application as a listener for events of type systemEventClass. The default implementation simply calls through to #subscribeToEvent(Class, Class, jakarta.faces.event.SystemEventListener) passing null as the sourceClass argument A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function . + jakarta.faces.application + Application + + + java.lang.Class + jakarta.faces.event.SystemEventListener + + + + + + JSF:JAVADOC:2302 + Remove the listener instance referenced by argument listener from the application as a listener for events of type systemEventClass that originate from objects of type sourceClass. See #subscribeToEvent(Class, Class, jakarta.faces.event.SystemEventListener) for the specification of how the listener is stored, and therefore, how it must be removed. See #subscribeToEvent(java.lang.Class,java.lang.Class,jakarta.faces.event.SystemEventListener) for an additional requirement regarding when it is valid to call this method. + jakarta.faces.application + Application + + + java.lang.Class + java.lang.Class + jakarta.faces.event.SystemEventListener + + + + + + JSF:JAVADOC:2303 + Remove the listener instance referenced by argument listener from the application as a listener for events of type systemEventClass. The default implementation simply calls through to #unsubscribeFromEvent(Class, jakarta.faces.event.SystemEventListener) passing null as the sourceClass argument See #subscribeToEvent(java.lang.Class,java.lang.Class,jakarta.faces.event.SystemEventListener) for an additional requirement regarding when it is valid to call this method. + jakarta.faces.application + Application + + + java.lang.Class + jakarta.faces.event.SystemEventListener + + + + + + JSF:JAVADOC:2304 + + jakarta.faces.application + ApplicationConfigurationPopulator + + + + + JSF:JAVADOC:2305 + Service providers that implement this service must be called by the Jakarta Faces runtime exactly once for each implementation, at startup, before any requests have been serviced. Before calling the #populateApplicationConfiguration method, the runtime must ensure that the Document argument is empty aside from being pre-configured to be in the proper namespace for an Application Configuration Resources file: https://jakarta.ee/xml/ns/jakartaee. Implementations of this service must ensure that any changes made to the argument Document conform to that schema as defined in the specification. The Jakarta Faces runtime is not required to validate the Document after control returns from the service implementation, though it may do so. Ordering of Artifacts If the document is made to contain an element, as specified in the section 11.3.8 "Ordering of Artifacts" in the Jakarta Faces Specification Document, the document will be prioritized accordingly. Otherwise, the runtime must place the document in the list of other Application Configuration Resources documents at the "lowest" priority, meaning any conflicts that may arise between the argument document and any other Application Configuration Resources are resolved in favor of the other document. + jakarta.faces.application + ApplicationConfigurationPopulator + + + org.w3c.dom.Document + + + + + + JSF:JAVADOC:2306 + If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.application + ApplicationFactory + + + jakarta.faces.application.ApplicationFactory + + + + + + JSF:JAVADOC:2307 + If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped. + jakarta.faces.application + ApplicationFactory + + + + + JSF:JAVADOC:2308 + The default behavior of this method is to call Application#addBehavior(String, String) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2309 + The default behavior of this method is to call Application#addComponent(String, String) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2310 + The default behavior of this method is to call Application#addConverter(String, String) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2311 + The default behavior of this method is to call Application#addConverter(Class, String) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.Class + java.lang.String + + + + + + JSF:JAVADOC:2312 + The default behavior of this method is to call Application#addDefaultValidatorId(String) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2313 + The default behavior of this method is to call Application#addELContextListener(jakarta.el.ELContextListener) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + jakarta.el.ELContextListener + + + + + + JSF:JAVADOC:2314 + The default behavior of this method is to call Application#addELResolver(jakarta.el.ELResolver) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + jakarta.el.ELResolver + + + + + + JSF:JAVADOC:2315 + Cause the argument resolver to be added to the head of the resolver chain. It is not possible to remove a SearchKeywordResolver registered with this method, once it has been registered. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend Application. + jakarta.faces.application + ApplicationWrapper + + + jakarta.faces.component.search.SearchKeywordResolver + + + + + + JSF:JAVADOC:2316 + The default behavior of this method is to call Application#addValidator(String, String) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2317 + + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2318 + If this application has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.application + ApplicationWrapper + + + jakarta.faces.application.Application + + + + + + JSF:JAVADOC:2319 + The default behavior of this method is to call Application#createBehavior(String) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2320 + + jakarta.faces.application + ApplicationWrapper + + + java.lang.String + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:2321 + The default behavior of this method is to call Application#createComponent(String) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2322 + + jakarta.faces.application + ApplicationWrapper + + + java.lang.String + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:2323 + The default behavior of this method is to call Application#createComponent(jakarta.el.ValueExpression, jakarta.faces.context.FacesContext, String) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + jakarta.el.ValueExpression + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2324 + + jakarta.faces.application + ApplicationWrapper + + + jakarta.el.ValueExpression + jakarta.faces.context.FacesContext + java.lang.String + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:2325 + The default behavior of this method is to call Application#createComponent(jakarta.el.ValueExpression, jakarta.faces.context.FacesContext, String, String) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + jakarta.el.ValueExpression + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2326 + The default behavior of this method is to call Application#createComponent(jakarta.faces.context.FacesContext, String, String) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2327 + The default behavior of this method is to call Application#createComponent(jakarta.faces.context.FacesContext, Resource) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.application.Resource + + + + + + JSF:JAVADOC:2328 + The default behavior of this method is to call Application#createConverter(String) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2329 + The default behavior of this method is to call Application#createConverter(Class) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.Class + + + + + + JSF:JAVADOC:2330 + The default behavior of this method is to call Application#createValidator(String) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2331 + + jakarta.faces.application + ApplicationWrapper + + + java.lang.String + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:2332 + The default behavior of this method is to call Application#evaluateExpressionGet(jakarta.faces.context.FacesContext, String, Class) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.Class + + + + + + JSF:JAVADOC:2333 + + jakarta.faces.application + ApplicationWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.Class + + jakarta.el.ELException + + + + + JSF:JAVADOC:2334 + The default behavior of this method is to call Application#getActionListener on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2335 + The default behavior of this method is to call Application#getBehaviorIds on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2336 + The default behavior of this method is to call Application#getComponentTypes on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2337 + The default behavior of this method is to call Application#getConverterIds on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2338 + The default behavior of this method is to call Application#getConverterTypes on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2339 + The default behavior of this method is to call Application#getDefaultLocale on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2340 + The default behavior of this method is to call Application#getDefaultRenderKitId on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2341 + The default behavior of this method is to call Application#getDefaultValidatorInfo on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2342 + The default behavior of this method is to call Application#getELContextListeners on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2343 + The default behavior of this method is to call Application#getELResolver on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2344 + The default behavior of this method is to call Application#getExpressionFactory on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2345 + Return the thread-safe singleton FlowHandler for this application. For implementations declaring compliance with version 2.2 of the specification, this method must never return null, even if the application has no flows. This is necessary to enable dynamic flow creation during the application's lifetime. All implementations that declare compliance with version 2.2 of the specification must implement this method. For the purpose of backward compatibility with environments that extend Application but do not override this method, an implementation is provided that returns null. Due to the decoratable nature of Application, code calling this method should always check for a null return. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2346 + The default behavior of this method is to call Application#getMessageBundle on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2347 + The default behavior of this method is to call Application#getNavigationHandler on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2348 + The default behavior of this method is to call Application#getProjectStage on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2349 + The default behavior of this method is to call Application#getResourceBundle(jakarta.faces.context.FacesContext, String) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2350 + The default behavior of this method is to call Application#getResourceHandler on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2351 + Return the thread-safe singleton SearchExpressionHandler for this application. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2352 + Return the singleton SearchKeywordResolver instance to be used for all search keyword resolution. This is actually an instance of a composite SearchKeywordResolver that must contain the following SearchKeywordResolver instances in the following order: SearchKeywordResolver instances declared using the element in the application configuration resources. Any SearchKeywordResolver instances added by calls to #addSearchKeywordResolver. The SearchKeywordResolver implementations for @all, @child(n), @form, @id(...), @namingcontainer, @next, @none, @parent, @previous, @root and @this. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend Application. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2353 + The default behavior of this method is to call Application#getStateManager on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2354 + The default behavior of this method is to call Application#getSupportedLocales on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2355 + The default behavior of this method is to call Application#getValidatorIds on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2356 + The default behavior of this method is to call Application#getViewHandler on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2357 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.application + ApplicationWrapper + + + + + JSF:JAVADOC:2358 + The default behavior of this method is to call Application#publishEvent(jakarta.faces.context.FacesContext, Class, Object) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + jakarta.faces.context.FacesContext + java.lang.Class + java.lang.Object + + + + + + JSF:JAVADOC:2359 + The default behavior of this method is to call Application#publishEvent(jakarta.faces.context.FacesContext, Class, Class, Object) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + jakarta.faces.context.FacesContext + java.lang.Class + java.lang.Class + java.lang.Object + + + + + + JSF:JAVADOC:2360 + The default behavior of this method is to call Application#removeELContextListener(jakarta.el.ELContextListener) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + jakarta.el.ELContextListener + + + + + + JSF:JAVADOC:2361 + The default behavior of this method is to call Application#setActionListener(jakarta.faces.event.ActionListener) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + jakarta.faces.event.ActionListener + + + + + + JSF:JAVADOC:2362 + The default behavior of this method is to call Application#setDefaultLocale(java.util.Locale) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.util.Locale + + + + + + JSF:JAVADOC:2363 + The default behavior of this method is to call Application#setDefaultRenderKitId(String) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2364 + Set the FlowHandler instance used by the NavigationHandler to satisfy the requirements of the faces flows feature. + jakarta.faces.application + ApplicationWrapper + + + jakarta.faces.flow.FlowHandler + + + + + + JSF:JAVADOC:2365 + The default behavior of this method is to call Application#setMessageBundle(String) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2366 + The default behavior of this method is to call Application#setNavigationHandler(NavigationHandler) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + jakarta.faces.application.NavigationHandler + + + + + + JSF:JAVADOC:2367 + The default behavior of this method is to call Application#setResourceHandler(ResourceHandler) on the wrapped Application object. This method can throw IllegalStateException and NullPointerException. + jakarta.faces.application + ApplicationWrapper + + + jakarta.faces.application.ResourceHandler + + + + + + JSF:JAVADOC:2368 + Set the SearchExpressionHandler instance used by the application. + jakarta.faces.application + ApplicationWrapper + + + jakarta.faces.component.search.SearchExpressionHandler + + + + + + JSF:JAVADOC:2369 + The default behavior of this method is to call Application#setStateManager(StateManager) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + jakarta.faces.application.StateManager + + + + + + JSF:JAVADOC:2370 + The default behavior of this method is to call Application#setSupportedLocales(java.util.Collection) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.util.Collection + + + + + + JSF:JAVADOC:2371 + The default behavior of this method is to call Application#setViewHandler(ViewHandler) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + jakarta.faces.application.ViewHandler + + + + + + JSF:JAVADOC:2372 + The default behavior of this method is to call Application#subscribeToEvent(Class, Class, jakarta.faces.event.SystemEventListener) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.Class + java.lang.Class + jakarta.faces.event.SystemEventListener + + + + + + JSF:JAVADOC:2373 + The default behavior of this method is to call Application#subscribeToEvent(Class, jakarta.faces.event.SystemEventListener) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.Class + jakarta.faces.event.SystemEventListener + + + + + + JSF:JAVADOC:2374 + The default behavior of this method is to call Application#unsubscribeFromEvent(Class, Class, jakarta.faces.event.SystemEventListener) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.Class + java.lang.Class + jakarta.faces.event.SystemEventListener + + + + + + JSF:JAVADOC:2375 + The default behavior of this method is to call Application#unsubscribeFromEvent(Class, jakarta.faces.event.SystemEventListener) on the wrapped Application object. + jakarta.faces.application + ApplicationWrapper + + + java.lang.Class + jakarta.faces.event.SystemEventListener + + + + + + JSF:JAVADOC:2376 + + jakarta.faces.application + ConfigurableNavigationHandler + + + + + JSF:JAVADOC:2377 + Return the NavigationCase representing the navigation that would be taken had NavigationHandler#handleNavigation been called with the same arguments or null if there is no such case. + jakarta.faces.application + ConfigurableNavigationHandler + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2378 + Return the NavigationCase representing the navigation that would be taken had NavigationHandler#handleNavigation been called with the same arguments or null if there is no such case. Implementations that comply the version of the specification in which this method was introduced must override this method. For compatibility with decorated implementations that comply with an earlier version of the specification, an implementation is provided that simply calls through to #getNavigationCase(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String), ignoring the toFlowDocumentId parameter. + jakarta.faces.application + ConfigurableNavigationHandler + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2379 + Return a Map where the keys are values and the values are Set where each element in the Set is a NavigationCase that applies to that . The implementation must support live modifications to this Map. + jakarta.faces.application + ConfigurableNavigationHandler + + + + + JSF:JAVADOC:2380 + Called by the flow system to cause the flow to be inspected for navigation rules. For backward compatibility with earlier implementations, an empty method is provided. + jakarta.faces.application + ConfigurableNavigationHandler + + + jakarta.faces.context.FacesContext + jakarta.faces.flow.Flow + + + + + + JSF:JAVADOC:2381 + A convenience method to signal the Jakarta Faces implementation to perform navigation with the provided outcome. When the NavigationHandler is invoked, the current viewId is treated as the "from viewId" and the "from action" is null. + jakarta.faces.application + ConfigurableNavigationHandler + + + java.lang.String + + + + + + JSF:JAVADOC:2382 + + jakarta.faces.application + ConfigurableNavigationHandlerWrapper + + + + + JSF:JAVADOC:2383 + If this configurable navigation handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.application + ConfigurableNavigationHandlerWrapper + + + jakarta.faces.application.ConfigurableNavigationHandler + + + + + + JSF:JAVADOC:2384 + Return the NavigationCase representing the navigation that would be taken had NavigationHandler#handleNavigation been called with the same arguments or null if there is no such case. + jakarta.faces.application + ConfigurableNavigationHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2385 + Return the NavigationCase representing the navigation that would be taken had NavigationHandler#handleNavigation been called with the same arguments or null if there is no such case. Implementations that comply the version of the specification in which this method was introduced must override this method. For compatibility with decorated implementations that comply with an earlier version of the specification, an implementation is provided that simply calls through to #getNavigationCase(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String), ignoring the toFlowDocumentId parameter. + jakarta.faces.application + ConfigurableNavigationHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2386 + Return a Map where the keys are values and the values are Set where each element in the Set is a NavigationCase that applies to that . The implementation must support live modifications to this Map. + jakarta.faces.application + ConfigurableNavigationHandlerWrapper + + + + + JSF:JAVADOC:2387 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.application + ConfigurableNavigationHandlerWrapper + + + + + JSF:JAVADOC:2388 + Perform navigation processing based on the state information in the specified FacesContext, plus the outcome string returned by an executed application action. If the implementation class also extends ConfigurableNavigationHandler, the implementation must guarantee that the logic used in a call to ConfigurableNavigationHandler#getNavigationCase is used in this method to determine the correct navigation. This method must set the render targets (used in partial rendering) to render all invoking jakarta.faces.context.PartialViewContext#setRenderAll) if the view identifier has changed as the result of an application action (to take into account Ajax requests). + jakarta.faces.application + ConfigurableNavigationHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2389 + Called by the flow system to cause the flow to be inspected for navigation rules. For backward compatibility with earlier implementations, an empty method is provided. + jakarta.faces.application + ConfigurableNavigationHandlerWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.flow.Flow + + + + + + JSF:JAVADOC:2390 + A convenience method to signal the Jakarta Faces implementation to perform navigation with the provided outcome. When the NavigationHandler is invoked, the current viewId is treated as the "from viewId" and the "from action" is null. + jakarta.faces.application + ConfigurableNavigationHandlerWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2391 + Construct a new jakarta.faces.application.FacesMessage with no initial values. The severity is set to Severity.INFO. + jakarta.faces.application + FacesMessage + + + + + JSF:JAVADOC:2392 + Construct a new jakarta.faces.application.FacesMessage with just a summary. The detail is null, the severity is set to Severity.INFO. + jakarta.faces.application + FacesMessage + + + java.lang.String + + + + + + JSF:JAVADOC:2393 + Construct a new jakarta.faces.application.FacesMessage with the specified initial values. The severity is set to Severity.INFO. + jakarta.faces.application + FacesMessage + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2394 + Construct a new FacesMessage with the specified initial values. + jakarta.faces.application + FacesMessage + + + jakarta.faces.application.FacesMessage.FacesMessage.Severity + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2395 + Return the localized detail text. If no localized detail text has been defined for this message, return the localized summary text instead. + jakarta.faces.application + FacesMessage + + + + + JSF:JAVADOC:2396 + Return the severity level. + jakarta.faces.application + FacesMessage + + + + + JSF:JAVADOC:2397 + Return the localized summary text. + jakarta.faces.application + FacesMessage + + + + + JSF:JAVADOC:2398 + + jakarta.faces.application + FacesMessage + + + + + JSF:JAVADOC:2399 + Marks this message as having been rendered to the client. + jakarta.faces.application + FacesMessage + + + + + JSF:JAVADOC:2400 + Set the localized detail text. + jakarta.faces.application + FacesMessage + + + java.lang.String + + + + + + JSF:JAVADOC:2401 + Set the severity level. + jakarta.faces.application + FacesMessage + + + jakarta.faces.application.FacesMessage.FacesMessage.Severity + + + + + + JSF:JAVADOC:2402 + Set the localized summary text. + jakarta.faces.application + FacesMessage + + + java.lang.String + + + + + + JSF:JAVADOC:2403 + Compare this jakarta.faces.application.FacesMessage.Severity instance to the specified one. Returns a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object. + jakarta.faces.application + FacesMessage.Severity + + + java.lang.Object + + + + + + JSF:JAVADOC:2404 + Return the ordinal value of this FacesMessage.Severity instance. + jakarta.faces.application + FacesMessage.Severity + + + + + JSF:JAVADOC:2405 + Return a String representation of this FacesMessage.Severity instance. + jakarta.faces.application + FacesMessage.Severity + + + + + JSF:JAVADOC:2406 + + jakarta.faces.application + NavigationCase + + + java.lang.Object + + + + + + JSF:JAVADOC:2407 + Construct an absolute URL to this NavigationCase instance using jakarta.faces.application.ViewHandler#getActionURL on the path portion of the url. + jakarta.faces.application + NavigationCase + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2408 + if the process of constructing the URL causes this exception to be thrown. + jakarta.faces.application + NavigationCase + + + jakarta.faces.context.FacesContext + + java.net.MalformedURLException + + + + + JSF:JAVADOC:2409 + Construct an absolute URL suitable for a bookmarkable link to this NavigationCase instance using jakarta.faces.application.ViewHandler#getBookmarkableURL on the path portion of the url. This URL may include view parameters specified as metadata within the view. + jakarta.faces.application + NavigationCase + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2410 + if the process of constructing the URL causes this exception to be thrown. + jakarta.faces.application + NavigationCase + + + jakarta.faces.context.FacesContext + + java.net.MalformedURLException + + + + + JSF:JAVADOC:2411 + Evaluates the for this , if any. The expression to be evaluated is passed into the constructor as a string. When the expression is evaluated, its value must be coerced into a boolean per the normal Jakarta Expression Language coercion rules. Note throws any exceptions encountered during the process of evaluating the expression or obtaining its value. + jakarta.faces.application + NavigationCase + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2412 + Return the for this + jakarta.faces.application + NavigationCase + + + + + JSF:JAVADOC:2413 + Return the for this + jakarta.faces.application + NavigationCase + + + + + JSF:JAVADOC:2414 + Return the of the inside which this is nested. + jakarta.faces.application + NavigationCase + + + + + JSF:JAVADOC:2415 + Return the parameters to be included for navigation cases requiring a redirect. If no parameters are defined, null will be returned. The keys in the Map are parameter names. For each key, the corresponding value is a List of unconverted values. + jakarta.faces.application + NavigationCase + + + + + JSF:JAVADOC:2416 + Construct an absolute URL suitable for a "redirect" to this NavigationCase instance using jakarta.faces.application.ViewHandler#getRedirectURL on the path portion of the url. + jakarta.faces.application + NavigationCase + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2417 + if the process of constructing the URL causes this exception to be thrown. + jakarta.faces.application + NavigationCase + + + jakarta.faces.context.FacesContext + + java.net.MalformedURLException + + + + + JSF:JAVADOC:2418 + Construct an absolute URL to this NavigationCase instance using jakarta.faces.application.ViewHandler#getResourceURL on the path portion of the url. + jakarta.faces.application + NavigationCase + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2419 + if the process of constructing the URL causes this exception to be thrown. + jakarta.faces.application + NavigationCase + + + jakarta.faces.context.FacesContext + + java.net.MalformedURLException + + + + + JSF:JAVADOC:2420 + If this navigation case represents a flow invocation, this property is the documentId in which the flow whose id is given by the return from #getFromOutcome() is defined. Implementations must override this method to return the value defined in the corresponding application configuration resources element. The base implementation returns the empty string. + jakarta.faces.application + NavigationCase + + + + + JSF:JAVADOC:2421 + Evaluates the for this + jakarta.faces.application + NavigationCase + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2422 + Test if this navigation case has an associated element. + jakarta.faces.application + NavigationCase + + + + + JSF:JAVADOC:2423 + + jakarta.faces.application + NavigationCase + + + + + JSF:JAVADOC:2424 + Return the value for this . This will be true if the view parametets should be encoded into the redirect URL (only applies to redirect case) + jakarta.faces.application + NavigationCase + + + + + JSF:JAVADOC:2425 + Return the value for this . This will be true if the new view should be navigated to via a jakarta.faces.context.ExternalContext#redirect(String) + jakarta.faces.application + NavigationCase + + + + + JSF:JAVADOC:2426 + Construct a new NavigationCase based on the provided arguments. See section 7.4.2 "Default NavigationHandler Algorithm" of the Jakarta Faces Specification Document for how a NavigationCase is used by the standard ConfigurableNavigationHandler + jakarta.faces.application + NavigationCase + + + java.lang.String + java.lang.String + java.lang.String + java.lang.String + java.lang.String + java.util.Map + boolean + boolean + + + + + + JSF:JAVADOC:2427 + Construct a new NavigationCase based on the provided arguments. See section 7.4.2 "Default NavigationHandler Algorithm" of the Jakarta Faces Specification Document for how a NavigationCase is used by the standard ConfigurableNavigationHandler + jakarta.faces.application + NavigationCase + + + java.lang.String + java.lang.String + java.lang.String + java.lang.String + java.lang.String + java.lang.String + java.util.Map + boolean + boolean + + + + + + JSF:JAVADOC:2428 + + jakarta.faces.application + NavigationCase + + + + + JSF:JAVADOC:2429 + + jakarta.faces.application + NavigationCaseWrapper + + + java.lang.Object + + + + + + JSF:JAVADOC:2430 + Construct an absolute URL to this NavigationCase instance using jakarta.faces.application.ViewHandler#getActionURL on the path portion of the url. + jakarta.faces.application + NavigationCaseWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2431 + if the process of constructing the URL causes this exception to be thrown. + jakarta.faces.application + NavigationCaseWrapper + + + jakarta.faces.context.FacesContext + + java.net.MalformedURLException + + + + + JSF:JAVADOC:2432 + Construct an absolute URL suitable for a bookmarkable link to this NavigationCase instance using jakarta.faces.application.ViewHandler#getBookmarkableURL on the path portion of the url. This URL may include view parameters specified as metadata within the view. + jakarta.faces.application + NavigationCaseWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2433 + if the process of constructing the URL causes this exception to be thrown. + jakarta.faces.application + NavigationCaseWrapper + + + jakarta.faces.context.FacesContext + + java.net.MalformedURLException + + + + + JSF:JAVADOC:2434 + Evaluates the for this , if any. The expression to be evaluated is passed into the constructor as a string. When the expression is evaluated, its value must be coerced into a boolean per the normal Jakarta Expression Language coercion rules. Note throws any exceptions encountered during the process of evaluating the expression or obtaining its value. + jakarta.faces.application + NavigationCaseWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2435 + Return the for this + jakarta.faces.application + NavigationCaseWrapper + + + + + JSF:JAVADOC:2436 + Return the for this + jakarta.faces.application + NavigationCaseWrapper + + + + + JSF:JAVADOC:2437 + Return the of the inside which this is nested. + jakarta.faces.application + NavigationCaseWrapper + + + + + JSF:JAVADOC:2438 + Return the parameters to be included for navigation cases requiring a redirect. If no parameters are defined, null will be returned. The keys in the Map are parameter names. For each key, the corresponding value is a List of unconverted values. + jakarta.faces.application + NavigationCaseWrapper + + + + + JSF:JAVADOC:2439 + Construct an absolute URL suitable for a "redirect" to this NavigationCase instance using jakarta.faces.application.ViewHandler#getRedirectURL on the path portion of the url. + jakarta.faces.application + NavigationCaseWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2440 + if the process of constructing the URL causes this exception to be thrown. + jakarta.faces.application + NavigationCaseWrapper + + + jakarta.faces.context.FacesContext + + java.net.MalformedURLException + + + + + JSF:JAVADOC:2441 + Construct an absolute URL to this NavigationCase instance using jakarta.faces.application.ViewHandler#getResourceURL on the path portion of the url. + jakarta.faces.application + NavigationCaseWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2442 + if the process of constructing the URL causes this exception to be thrown. + jakarta.faces.application + NavigationCaseWrapper + + + jakarta.faces.context.FacesContext + + java.net.MalformedURLException + + + + + JSF:JAVADOC:2443 + If this navigation case represents a flow invocation, this property is the documentId in which the flow whose id is given by the return from #getFromOutcome() is defined. Implementations must override this method to return the value defined in the corresponding application configuration resources element. The base implementation returns the empty string. + jakarta.faces.application + NavigationCaseWrapper + + + + + JSF:JAVADOC:2444 + Evaluates the for this + jakarta.faces.application + NavigationCaseWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2445 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.application + NavigationCaseWrapper + + + + + JSF:JAVADOC:2446 + Test if this navigation case has an associated element. + jakarta.faces.application + NavigationCaseWrapper + + + + + JSF:JAVADOC:2447 + + jakarta.faces.application + NavigationCaseWrapper + + + + + JSF:JAVADOC:2448 + Return the value for this . This will be true if the view parametets should be encoded into the redirect URL (only applies to redirect case) + jakarta.faces.application + NavigationCaseWrapper + + + + + JSF:JAVADOC:2449 + Return the value for this . This will be true if the new view should be navigated to via a jakarta.faces.context.ExternalContext#redirect(String) + jakarta.faces.application + NavigationCaseWrapper + + + + + JSF:JAVADOC:2450 + + jakarta.faces.application + NavigationCaseWrapper + + + + + JSF:JAVADOC:2451 + If this navigation case has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.application + NavigationCaseWrapper + + + jakarta.faces.application.NavigationCase + + + + + + JSF:JAVADOC:2452 + + jakarta.faces.application + NavigationCaseWrapper + + + + + JSF:JAVADOC:2453 + Perform navigation processing based on the state information in the specified FacesContext, plus the outcome string returned by an executed application action. If the implementation class also extends ConfigurableNavigationHandler, the implementation must guarantee that the logic used in a call to ConfigurableNavigationHandler#getNavigationCase is used in this method to determine the correct navigation. This method must set the render targets (used in partial rendering) to render all invoking jakarta.faces.context.PartialViewContext#setRenderAll) if the view identifier has changed as the result of an application action (to take into account Ajax requests). + jakarta.faces.application + NavigationHandler + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2454 + Overloaded variant of #handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) that allows the caller to provide the defining document id for a flow to be entered by this navigation. For backward compatibility with decorated NavigationHandler implementations that conform to an earlier version of the specification, an implementation is provided that calls through to #handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String), ignoring the toFlowDocumentId parameter. + jakarta.faces.application + NavigationHandler + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2455 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.application + NavigationHandlerWrapper + + + + + JSF:JAVADOC:2456 + Perform navigation processing based on the state information in the specified FacesContext, plus the outcome string returned by an executed application action. If the implementation class also extends ConfigurableNavigationHandler, the implementation must guarantee that the logic used in a call to ConfigurableNavigationHandler#getNavigationCase is used in this method to determine the correct navigation. This method must set the render targets (used in partial rendering) to render all invoking jakarta.faces.context.PartialViewContext#setRenderAll) if the view identifier has changed as the result of an application action (to take into account Ajax requests). + jakarta.faces.application + NavigationHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2457 + Overloaded variant of #handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String) that allows the caller to provide the defining document id for a flow to be entered by this navigation. For backward compatibility with decorated NavigationHandler implementations that conform to an earlier version of the specification, an implementation is provided that calls through to #handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String), ignoring the toFlowDocumentId parameter. + jakarta.faces.application + NavigationHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2458 + + jakarta.faces.application + NavigationHandlerWrapper + + + + + JSF:JAVADOC:2459 + If this navigation handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.application + NavigationHandlerWrapper + + + jakarta.faces.application.NavigationHandler + + + + + + JSF:JAVADOC:2460 + + jakarta.faces.application + ProjectStage + + + java.lang.String + + + + + + JSF:JAVADOC:2461 + + jakarta.faces.application + ProjectStage + + + + + JSF:JAVADOC:2462 + Construct a new exception with no detail message or root cause. + jakarta.faces.application + ProtectedViewException + + + + + JSF:JAVADOC:2463 + Construct a new exception with the specified detail message and no root cause. + jakarta.faces.application + ProtectedViewException + + + java.lang.String + + + + + + JSF:JAVADOC:2464 + Construct a new exception with the specified root cause. The detail message will be set to (cause == null ? null : cause.toString() + jakarta.faces.application + ProtectedViewException + + + java.lang.Throwable + + + + + + JSF:JAVADOC:2465 + Construct a new exception with the specified detail message and root cause. + jakarta.faces.application + ProtectedViewException + + + java.lang.String + java.lang.Throwable + + + + + + JSF:JAVADOC:2466 + Return the MIME content-type for this resource. + jakarta.faces.application + Resource + + + + + JSF:JAVADOC:2467 + If the current request is a resource request, (that is, ResourceHandler#isResourceRequest returns true), return an InputStream containing the bytes of the resource. Otherwise, throw an IOException. + jakarta.faces.application + Resource + + + + + JSF:JAVADOC:2468 + if the current request is not a resource request. + jakarta.faces.application + Resource + + java.io.IOException + + + + + JSF:JAVADOC:2469 + Return the libraryName for this resource. May be null. The libraryName for a resource is an optional String that indicates membership in a "resource library". All resources with the same libraryName belong to the same "resource library". The "resource library" concept allows disambiguating resources that have the same resourceName. See ResourceHandler for more information. + jakarta.faces.application + Resource + + + + + JSF:JAVADOC:2470 + Return a path to this resource such that, when the browser resolves it against the base URI for the view that includes the resource, and issues a GET request to the resultant fully qualified URL, the bytes of the resource are returned in response. The default implementation must implement the following algorithm. For discussion, the return result from this method will be called result. Get the context-root for this web application, not ending in slash. For discussion this will be called contextRoot. Discover if the FacesServlet is prefix (path) mapped, extension mapped, or exact mapped (as defined by Servlet.12.2.) and the value of the mapping (including the leading '.' in the case of extension mapping). For discussion, this will be facesServletMapping. If exact mapped, result must be the following if and only if the FacesServlet is mapped to the exact URL pattern ResourceHandler#RESOURCE_IDENTIFIER + #getResourceName result = contextRoot + ResourceHandler#RESOURCE_IDENTIFIER + #getResourceName If exact mapped, and the FacesServlet is not mapped to the exact URL pattern ResourceHandler#RESOURCE_IDENTIFIER + #getResourceName do the following: Retrieve the existing mappings of the FacesServlet, e.g. using ServletRegistration#getMappings(), and from those pick any prefix mapping or extension mapping. If no such mapping is found, throw an IllegalStateException. If such mapping is found remove the * character from that mapping, take that as the new facesServletMapping and continue with evaluating this mapping as specified below for if prefix mapped and for if extension mapped If prefix mapped, result must be result = contextRoot + '/' + facesServletMapping + ResourceHandler#RESOURCE_IDENTIFIER + '/' + #getResourceName If extension mapped, result must be result = contextRoot + ResourceHandler#RESOURCE_IDENTIFIER + #getResourceName + facesServletMapping Build up a string, called resourceMetaData which is an amp; separated string of name=value pairs suitable for inclusion in a URL query string. If #getLibraryName returns non-null, resourceMetaData must include "ln=" + the return from #getLibraryName If there is a localePrefix for this application, as defined in ResourceHandler#LOCALE_PREFIX, resourceMetaData must include "loc=" + the localePrefix. If this resource is contained in a resource library contract, resourceMetaData must include "con=" + the name of the resource library contract. Append "?" + resourceMetaData to result. Make it portlet safe by passing the result through ViewHandler#getResourceURL. + jakarta.faces.application + Resource + + + + + JSF:JAVADOC:2471 + Return the resourceName for this resource. Will never be null. All Resource instances must have a resourceName. + jakarta.faces.application + Resource + + + + + JSF:JAVADOC:2472 + Returns a mutable Map whose entries will be sent as response headers during ResourceHandler#handleResourceRequest. The entries in this map must not persist beyond the scope of a single request. Any modifications made to the map after the resource has been served will be ignored by the run-time. + jakarta.faces.application + Resource + + + + + JSF:JAVADOC:2473 + Return an actual URL instance that refers to this resource instance. + jakarta.faces.application + Resource + + + + + JSF:JAVADOC:2474 + + jakarta.faces.application + Resource + + + + + JSF:JAVADOC:2475 + Set the MIME content-type for this resource. The default implementation performs no validation on the argument. + jakarta.faces.application + Resource + + + java.lang.String + + + + + + JSF:JAVADOC:2476 + Set the libraryName for this resource. + jakarta.faces.application + Resource + + + java.lang.String + + + + + + JSF:JAVADOC:2477 + Set the resourceName for this resource. + jakarta.faces.application + Resource + + + java.lang.String + + + + + + JSF:JAVADOC:2478 + Call through to #getRequestPath and return the result. + jakarta.faces.application + Resource + + + + + JSF:JAVADOC:2479 + Return true if the user-agent requesting this resource needs an update. If the If-Modified-Since HTTP header is available for this request, its value must be consulted, as specified in Section 14.25 of IETF RFC 2616, to determine the result. Returns false if the user-agent does not need an update for this resource. + jakarta.faces.application + Resource + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2480 + The individual resource dependencies + jakarta.faces.application + ResourceDependencies + + + + + JSF:JAVADOC:2481 + The libraryName in which the resource pointed to by this ResourceDependency resides. If not specified, defaults to the empty string. It is valid to have Jakarta Expression Language Expressions in the value of this attribute, as long as the expression resolves to an instance of the expected type. + jakarta.faces.application + ResourceDependency + + + + + JSF:JAVADOC:2482 + The resourceName of the resource pointed to by this ResourceDependency. It is valid to have Jakarta Expression Language Expressions in the value of this attribute, as long as the expression resolves to an instance of the expected type. + jakarta.faces.application + ResourceDependency + + + + + JSF:JAVADOC:2483 + The value given for this attribute will be passed as the "target" argument to jakarta.faces.component.UIViewRoot#addComponentResource(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.String). If this attribute is specified, jakarta.faces.component.UIViewRoot#addComponentResource(jakarta.faces.context.FacesContext,jakarta.faces.component.UIComponent) must be called instead, as described above. It is valid to have Jakarta Expression Language Expressions in the value of this attribute, as long as the expression resolves to an instance of the expected type. + jakarta.faces.application + ResourceDependency + + + + + JSF:JAVADOC:2484 + Create an instance of ViewResource given the argument resourceName. The content-type of the resource is derived by passing the resourceName to jakarta.faces.context.ExternalContext#getMimeType The algorithm specified in section 2.6.1.4 "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document must be executed to create the Resource. New requirements were introduced in version 2.2 of the specification. For historical reasons, this method operate correctly when the argument resourceName is of the form libraryName/resourceName, even when resourceName contains '/' characters. + jakarta.faces.application + ResourceHandler + + + java.lang.String + + + + + + JSF:JAVADOC:2485 + Create an instance of Resource with a resourceName given by the value of the argument resourceName that is a member of the library named by the argument libraryName. The content-type of the resource is derived by passing the resourceName to jakarta.faces.context.ExternalContext#getMimeType. The algorithm specified in section 2.6.1.4 "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document must be executed to create the Resource. New requirements were introduced in version 2.2 of the specification. + jakarta.faces.application + ResourceHandler + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2486 + Create an instance of Resource with a resourceName given by the value of the argument resourceName that is a member of the library named by the argument libraryName that claims to have the content-type given by the argument content-type. The algorithm specified in section 2.6.1.4 "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document must be executed to create the Resource. New requirements were introduced in version 2.2 of the specification. + jakarta.faces.application + ResourceHandler + + + java.lang.String + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2487 + Create an instance of Resource given the argument resourceId. The content-type of the resource is derived by passing the resourceName to jakarta.faces.context.ExternalContext#getMimeType The resource must be identified according to the specification in section 2.6.1.3 "Resource Identifiers" of the Jakarta Faces Specification Document. New requirements were introduced in version 2.2 of the specification. + jakarta.faces.application + ResourceHandler + + + java.lang.String + + + + + + JSF:JAVADOC:2488 + Create an instance of Resource given the argument resourceName, which may contain "/" characters. The jakarta.faces.view.ViewDeclarationLanguage calls this method when it needs to load a view from a persistent store, such as a filesystem. This method is functionality equivalent to #createResource(java.lang.String), but all callsites that need to load VDL views must use this method so that classes that want to decorate the ResourceHandler in order to only affect the loading of views may do so without affecting the processing of other kinds of resources, such as scripts and stylesheets. A jakarta.faces.context.FacesContext must be present before calling this method. To preserve compatibility with prior revisions of the specification, a default implementation must be provided that calls #createResource(java.lang.String). The default implementation must look for the resource in the following places, in this order. Considering resource library contracts (at the locations specified in the Jakarta Faces Specification Document section 2.7 "Resource Library Contracts"). Considering the web app root. Considering faces flows (at the locations specified in the Jakarta Faces Specification Document section 11.3.3 "Faces Flows"). Call FacesContext#getResourceLibraryContracts. If the result is non-null and not empty, for each value in the list, treat the value as the name of a resource library contract. If the argument resoureName exists as a resource in the resource library contract, return it. Otherwise, return the resource (not in the resource library contract), if found. Otherwise, return null. + jakarta.faces.application + ResourceHandler + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2489 + Return the renderer-type for a jakarta.faces.render.Renderer that is capable of rendering this resource. The default implementation must return values according to the following table. If no renderer-type can be determined, null must be returned. resource name to renderer-type mapping example resource name renderer-type mycomponent.js jakarta.faces.resource.Script mystyle.css jakarta.faces.resource.Stylesheet + jakarta.faces.application + ResourceHandler + + + java.lang.String + + + + + + JSF:JAVADOC:2490 + Return a Stream possibly lazily populated by walking the resource tree rooted at a given initial path. The resource tree is traversed breadth-first, the elements in the stream are view resource names that would yield a ViewResource when passed into ResourceHandler#createViewResource as the resourceName parameter. The maxDepth parameter is the maximum depth of directory levels to visit beyond the initial path, which is always visited. The value is relative to the root (/), not to the given initial path. E.g. given maxDepth = 3 and initial path /foo/, visiting will proceed up to /foo/bar/, where / counts as depth 1, /foo/ as depth 2 and /foo/bar/ as depth 3. A value lower or equal to the depth of the initial path means that only the initial path is visited. A value of Integer#MAX_VALUE MAX_VALUE may be used to indicate that all levels should be visited. + jakarta.faces.application + ResourceHandler + + + jakarta.faces.context.FacesContext + java.lang.String + int + jakarta.faces.application.ResourceVisitOption[] + + + + + + JSF:JAVADOC:2491 + Return a Stream possibly lazily populated by walking the resource tree rooted at a given initial path. The resource tree is traversed breadth-first, the elements in the stream are view resource names that would yield a ViewResource when passed into ResourceHandler#createViewResource as the resourceName parameter. This method works as if invoking it were equivalent to evaluating the expression: getViewResources(facesContext, start, Integer.MAX_VALUE, options) Put differently, it visits all levels of the resource tree. + jakarta.faces.application + ResourceHandler + + + jakarta.faces.context.FacesContext + java.lang.String + jakarta.faces.application.ResourceVisitOption[] + + + + + + JSF:JAVADOC:2492 + This method specifies the contract for satisfying resource requests. This method is called from jakarta.faces.webapp.FacesServlet#service after that method determines the current request is a resource request by calling #isResourceRequest. Thus, handleResourceRequest may assume that the current request is a resource request. The default implementation must implement an algorithm semantically identical to the following algorithm. For discussion, in all cases when a status code is to be set, this spec talks only using the Jakarta Servlet API, but it is understood that in a portlet environment the appropriate equivalent API must be used. If the resourceIdentifier ends with any of the extensions listed in the value of the #RESOURCE_EXCLUDES_PARAM_NAME init parameter, HttpServletRequest.SC_NOT_FOUND must be passed to HttpServletResponse.setStatus(), then handleResourceRequest must immediately return. Extract the resourceName from the resourceIdentifier by taking the substring of resourceIdentifier that starts at #RESOURCE_IDENTIFIER.length() + 1 and goes to the end of resourceIdentifier. If no resourceName can be extracted, HttpServletRequest.SC_NOT_FOUND must be passed to HttpServletResponse.setStatus(), then handleResourceRequest must immediately return. Extract the libraryName from the request by looking in the request parameter map for an entry under the key "ln", without the quotes. If found, use its value as the libraryName. If resourceName and libraryName are present, call #createResource(String, String) to create the Resource. If only resourceName is present, call #createResource(String) to create the Resource. If the Resource cannot be successfully created, HttpServletRequest.SC_NOT_FOUND must be passed to HttpServletResponse.setStatus(), then handleResourceRequest must immediately return. Call Resource#userAgentNeedsUpdate. If this method returns false, HttpServletRequest.SC_NOT_MODIFIED must be passed to HttpServletResponse.setStatus(), then handleResourceRequest must immediately return. Pass the result of Resource#getContentType to HttpServletResponse.setContentType. Call Resource#getResponseHeaders. For each entry in this Map, call HttpServletResponse.setHeader(), passing the key as the first argument and the value as the second argument. Call Resource#getInputStream and serve up the bytes of the resource to the response. Call HttpServletResponse.setContentLength() passing the byte count of the resource. If an IOException is thrown during any of the previous steps, log a descriptive, localized message, including the resourceName and libraryName (if present). Then, HttpServletRequest.SC_NOT_FOUND must be passed to HttpServletResponse.setStatus(), then handleResourceRequest must immediately return. In all cases in this method, any streams, channels, sockets, or any other IO resources must be closed before this method returns. + jakarta.faces.application + ResourceHandler + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2493 + when an I/O error occurs. + jakarta.faces.application + ResourceHandler + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + JSF:JAVADOC:2494 + Returns whether the resource as identified by given resource and library name has been rendered. The default implementation must during the render response phase of the current view return true when the resource has been marked as rendered via #markResourceRendered(FacesContext, String, String). + jakarta.faces.application + ResourceHandler + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2495 + Return true if the current request is a resource request. This method is called by jakarta.faces.webapp.FacesServlet#service to determine if this request is a view request or a resource request. + jakarta.faces.application + ResourceHandler + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2496 + Return true if the argument url contains the string given by the value of the constant ResourceHandler#RESOURCE_IDENTIFIER, false otherwise. + jakarta.faces.application + ResourceHandler + + + java.lang.String + + + + + + JSF:JAVADOC:2497 + Return true if the resource library named by the argument libraryName can be found. If there is a localePrefix for this application, as defined in #LOCALE_PREFIX, first look for the library with the prefix. If no such library is found, look for the library without the prefix. This allows developers to avoid duplication of files. For example, consider the case where the developer wants to have a resource library containing a localized image resource and a non-localized script resource. By checking both locations for the existence of the library, along with other spec changes in section 2.6.1.4 "Libraries of Localized and Versioned Resources" of the Jakarta Faces Specification Document, this scenario is enabled. + jakarta.faces.application + ResourceHandler + + + java.lang.String + + + + + + JSF:JAVADOC:2498 + Mark the resource as identified by given resource and library name as rendered. The default implementation must ensure that #isResourceRendered(FacesContext, String, String) will return true when the resource has already been rendered during the render response phase of the current view. + jakarta.faces.application + ResourceHandler + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2499 + + jakarta.faces.application + ResourceHandler + + + + + JSF:JAVADOC:2500 + The default behavior of this method is to call ResourceHandler#createResource(String) on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceHandlerWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2501 + The default behavior of this method is to call ResourceHandler#createResource(String, String) on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceHandlerWrapper + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2502 + The default behavior of this method is to call ResourceHandler#createResource(String, String, String) on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceHandlerWrapper + + + java.lang.String + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2503 + The default behavior of this method is to call ResourceHandler#createResourceFromId(String) on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceHandlerWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2504 + The default behavior of this method is to call ResourceHandler#createViewResource on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2505 + The default behavior of this method is to call ResourceHandler#getRendererTypeForResourceName(String) on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceHandlerWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2506 + The default behavior of this method is to call ResourceHandler#getViewResources(FacesContext, String, int, ResourceVisitOption...) on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + int + jakarta.faces.application.ResourceVisitOption[] + + + + + + JSF:JAVADOC:2507 + The default behavior of this method is to call ResourceHandler#getViewResources(FacesContext, String, ResourceVisitOption...) on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + jakarta.faces.application.ResourceVisitOption[] + + + + + + JSF:JAVADOC:2508 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.application + ResourceHandlerWrapper + + + + + JSF:JAVADOC:2509 + The default behavior of this method is to call ResourceHandler#handleResourceRequest(jakarta.faces.context.FacesContext) on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceHandlerWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2510 + + jakarta.faces.application + ResourceHandlerWrapper + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + JSF:JAVADOC:2511 + The default behavior of this method is to call ResourceHandler#isResourceRendered(FacesContext, String, String) on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2512 + The default behavior of this method is to call ResourceHandler#isResourceRequest(jakarta.faces.context.FacesContext) on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceHandlerWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2513 + The default behavior of this method is to call ResourceHandler#isResourceURL on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceHandlerWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2514 + The default behavior of this method is to call ResourceHandler#libraryExists(String) on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceHandlerWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2515 + The default behavior of this method is to call ResourceHandler#markResourceRendered(FacesContext, String, String) on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2516 + + jakarta.faces.application + ResourceHandlerWrapper + + + + + JSF:JAVADOC:2517 + If this resource handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.application + ResourceHandlerWrapper + + + jakarta.faces.application.ResourceHandler + + + + + + JSF:JAVADOC:2518 + + jakarta.faces.application + ResourceVisitOption + + + java.lang.String + + + + + + JSF:JAVADOC:2519 + + jakarta.faces.application + ResourceVisitOption + + + + + JSF:JAVADOC:2520 + The default behavior of this method is to call Resource#getContentType() on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceWrapper + + + + + JSF:JAVADOC:2521 + The default behavior of this method is to call Resource#getInputStream on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceWrapper + + + + + JSF:JAVADOC:2522 + + jakarta.faces.application + ResourceWrapper + + java.io.IOException + + + + + JSF:JAVADOC:2523 + The default behavior of this method is to call Resource#getLibraryName() on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceWrapper + + + + + JSF:JAVADOC:2524 + The default behavior of this method is to call Resource#getRequestPath on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceWrapper + + + + + JSF:JAVADOC:2525 + The default behavior of this method is to call Resource#getResourceName() on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceWrapper + + + + + JSF:JAVADOC:2526 + The default behavior of this method is to call Resource#getResponseHeaders on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceWrapper + + + + + JSF:JAVADOC:2527 + The default behavior of this method is to call Resource#getURL on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceWrapper + + + + + JSF:JAVADOC:2528 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.application + ResourceWrapper + + + + + JSF:JAVADOC:2529 + If this resource has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.application + ResourceWrapper + + + jakarta.faces.application.Resource + + + + + + JSF:JAVADOC:2530 + + jakarta.faces.application + ResourceWrapper + + + + + JSF:JAVADOC:2531 + The default behavior of this method is to call Resource#setContentType(String) on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2532 + The default behavior of this method is to call Resource#setLibraryName(String) on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2533 + The default behavior of this method is to call Resource#setResourceName(String) on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2534 + The default behavior of this method is to call Resource#userAgentNeedsUpdate on the wrapped ResourceHandler object. + jakarta.faces.application + ResourceWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2535 + Convenience method to return the view state as a String with no RenderKit specific markup. This default implementation of this method will call StateManagementStrategy#saveView(FacesContext) and passing the result to and returning the resulting value from ResponseStateManager#getViewState(jakarta.faces.context.FacesContext, Object). + jakarta.faces.application + StateManager + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2536 + Method to determine if the state is saved on the client. + jakarta.faces.application + StateManager + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2537 + + jakarta.faces.application + StateManager + + + + + JSF:JAVADOC:2538 + Save the state represented in the specified state Object instance, in an implementation dependent manner. This method will typically simply delegate the actual writing to the writeState() method of the ResponseStateManager instance provided by the RenderKit being used to render this view. This method assumes that the caller has positioned the ResponseWriter at the correct position for the saved state to be written. + jakarta.faces.application + StateManager + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:2539 + when an I/O error occurs. + jakarta.faces.application + StateManager + + + jakarta.faces.context.FacesContext + java.lang.Object + + java.io.IOException + + + + + JSF:JAVADOC:2540 + The default behavior of this method is to call StateManager#getViewState(jakarta.faces.context.FacesContext) on the wrapped StateManager object. + jakarta.faces.application + StateManagerWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2541 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.application + StateManagerWrapper + + + + + JSF:JAVADOC:2542 + The default behavior of this method is to call StateManager#isSavingStateInClient(jakarta.faces.context.FacesContext) on the wrapped StateManager object. + jakarta.faces.application + StateManagerWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2543 + If this state manager has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.application + StateManagerWrapper + + + jakarta.faces.application.StateManager + + + + + + JSF:JAVADOC:2544 + The default behavior of this method is to call StateManager#writeState(jakarta.faces.context.FacesContext, java.lang.Object) on the wrapped StateManager object. + jakarta.faces.application + StateManagerWrapper + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:2545 + + jakarta.faces.application + StateManagerWrapper + + + jakarta.faces.context.FacesContext + java.lang.Object + + java.io.IOException + + + + + JSF:JAVADOC:2546 + Return the message for this exception prepended with the view identifier if the view identifier is not null, otherwise, return the message. + jakarta.faces.application + ViewExpiredException + + + + + JSF:JAVADOC:2547 + Return the view identifier of this exception, or null if the view identifier is nonexistent or unknown. + jakarta.faces.application + ViewExpiredException + + + + + JSF:JAVADOC:2548 + Construct a new exception with no detail message or root cause. + jakarta.faces.application + ViewExpiredException + + + + + JSF:JAVADOC:2549 + Construct a new exception with the specified view identifier. + jakarta.faces.application + ViewExpiredException + + + java.lang.String + + + + + + JSF:JAVADOC:2550 + Construct a new exception with the specified detail message and no root cause. + jakarta.faces.application + ViewExpiredException + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:2551 + Construct a new exception with the specified root cause. The detail message will be set to (cause == null ? null : cause.toString() + jakarta.faces.application + ViewExpiredException + + + java.lang.Throwable + java.lang.String + + + + + + JSF:JAVADOC:2552 + Construct a new exception with the specified detail message and root cause. + jakarta.faces.application + ViewExpiredException + + + java.lang.String + java.lang.Throwable + java.lang.String + + + + + + JSF:JAVADOC:2553 + Add the argument urlPattern to the thread safe Set of protected views for this application. Compliant implementations make it so a subsequent call to #getProtectedViewsUnmodifiable contains the argument. The runtime must support calling this method at any time after application startup. The default implementation takes no action. + jakarta.faces.application + ViewHandler + + + java.lang.String + + + + + + JSF:JAVADOC:2554 + Returns the correct character encoding to be used for this request. The following algorithm is employed. Examine the Content-Type request header. If it has a charset parameter, extract it and return that as the encoding. If no charset parameter was found, check for the existence of a session by calling ExternalContext#getSession(boolean) passing false as the argument. If that method returns true, get the session Map by calling ExternalContext#getSessionMap and look for a value under the key given by the value of the symbolic constant ViewHandler#CHARACTER_ENCODING_KEY. If present, return the value, converted to String. Otherwise, return null + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2555 + Returns an appropriate Locale to use for this and subsequent requests for the current client. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2556 + Return an appropriate renderKitId for this and subsequent requests from the current client. It is an error for this method to return null. The default return value is jakarta.faces.render.RenderKitFactory#HTML_BASIC_RENDER_KIT. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2557 + Create and return a new UIViewRoot instance initialized with information from the argument FacesContext and viewId. Locate the ViewDeclarationLanguage implementation for the VDL used in the view. The argument viewId must be converted to a physical viewId that can refer to an actual resource suitable for use by the ViewDeclarationLanguage ViewDeclarationLanguage#createView, which must be called by this method. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2558 + Derive and return the viewId from the current request, or the argument input by following the algorithm defined in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document. Note that unlike deriveViewId(), this method does not require that a physical view be present. This method should work correctly when the FacesServlet is invoked via either a path mapping, extension mapping or an exact match (mapping) as defined by Servlet.12.2. Note that path mapping is also commonly known as prefix mapping (e.g. "/faces/*") and extension mapping as suffix mapping (e.g. "*.xhtml"). An exact match is possible where there's a servlet mapping with an exact URL pattern such as "/foo". The default implementation of this method simply returns requestViewId unchanged. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2559 + Derive and return the viewId from the current request, or the argument input by following the algorithm defined in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document. This method should work correctly when the FacesServlet is invoked via either a path mapping, extension mapping or an exact match (mapping) as defined by Servlet.12.2. Note that path mapping is also commonly known as prefix mapping (e.g. "/faces/*") and extension mapping as suffix mapping (e.g. "*.xhtml"). An exact match is possible where there's a servlet mapping with an exact URL pattern such as "/foo". The default implementation of this method simply returns requestViewId unchanged. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2560 + If the value returned from this method is used as the file argument to the four-argument constructor for java.net.URL (assuming appropriate values are used for the first three arguments), then a client making a request to the toExternalForm() of that URL will select the argument viewId for traversing the Jakarta Faces lifecycle. Please see section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document for the complete specification, especially for details related to view protection using the jakarta.faces.render.ResponseStateManager#NON_POSTBACK_VIEW_TOKEN_PARAM and the behavior when the current request is to a URL for which the FacesServlet has an exact mapping as defined by Servlet.12.2. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2561 + Return a Jakarta Faces action URL derived from the viewId argument that is suitable to be used as the target of a link in a Jakarta Faces response. Compliant implementations must implement this method as specified in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document. The default implementation simply calls through to #getActionURL, passing the arguments context and viewId. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + java.lang.String + java.util.Map + boolean + + + + + + JSF:JAVADOC:2562 + Return an unmodifiable Set of the protected views currently known to this ViewHandler instance. Compliant implementations must return a Set that is the concatenation of the contents of all the elements within all the in all of the application configuration resources in the current application. The runtime must support calling this method at any time after application startup. The default implementation returns an unmodifiable empty Set. + jakarta.faces.application + ViewHandler + + + + + JSF:JAVADOC:2563 + Return a Jakarta Faces action URL derived from the viewId argument that is suitable to be used by the NavigationHandler to issue a redirect request to the URL using a NonFaces request. Compliant implementations must implement this method as specified in section 7.6.2 "Default ViewHandler Implementation" of the Jakarta Faces Specification Document. The default implementation simply calls through to #getActionURL, passing the arguments context and viewId. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + java.lang.String + java.util.Map + boolean + + + + + + JSF:JAVADOC:2564 + If the value returned from this method is used as the file argument to the four-argument constructor for java.net.URL (assuming appropriate values are used for the first three arguments), then a client making a request to the toExternalForm() of that URL will select the argument path for direct rendering. If the specified path starts with a slash, it must be treated as context relative; otherwise, it must be treated as relative to the action URL of the current view. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2565 + Return the ViewDeclarationLanguage instance used for this ViewHandler instance. The default implementation must use jakarta.faces.view.ViewDeclarationLanguageFactory#getViewDeclarationLanguage to obtain the appropriate ViewDeclarationLanguage implementation for the argument viewId. Any exceptions thrown as a result of invoking that method must not be swallowed. The default implementation of this method returns null. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2566 + Return a Stream possibly lazily populated by walking the view trees of every active ViewDeclarationLanguage rooted at a given initial path. The view tree of every ViewDeclarationLanguage is individually traversed breadth-first as per the contract of ViewDeclarationLanguage#getViews(FacesContext, String, int, ViewVisitOption...). The elements in the stream are logical view ids. The maxDepth parameter is the maximum depth of directory levels to visit for each ViewDeclarationLanguage beyond the initial path, which is always visited. The value is relative to the root (/), not to the given initial path. E.g. given maxDepth = 3 and initial path /foo/, visiting will proceed up to /foo/bar/, where / counts as depth 1, /foo/ as depth 2 and /foo/bar/ as depth 3. A value lower or equal to the depth of the initial path means that only the initial path is visited. A value of Integer#MAX_VALUE MAX_VALUE may be used to indicate that all levels should be visited. In case more than one active ViewDeclarationLanguage is present, the order in which view ids from each ViewDeclarationLanguage appear in the stream is undetermined, except for the guarantee that every individual ViewDeclarationLanguage is traversed breadth-first. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + java.lang.String + int + jakarta.faces.application.ViewVisitOption[] + + + + + + JSF:JAVADOC:2567 + Return a Stream possibly lazily populated by walking the view trees of every active ViewDeclarationLanguage rooted at a given initial path. The view tree of every ViewDeclarationLanguage is individually traversed breadth-first as per the contract of ViewDeclarationLanguage#getViews(FacesContext, String, int, ViewVisitOption...). The elements in the stream are logical view ids. This method works as if invoking it were equivalent to evaluating the expression: getViews(facesContext, start, Integer.MAX_VALUE, options) Put differently, it visits all levels of the view tree. In case more than one active ViewDeclarationLanguage is present, the order in which view ids from each ViewDeclarationLanguage appear in the stream is undetermined, except for the guarantee that every individual ViewDeclarationLanguage is traversed breadth-first. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + java.lang.String + jakarta.faces.application.ViewVisitOption[] + + + + + + JSF:JAVADOC:2568 + If the value returned from this method is used as the file argument to the four-argument constructor for java.net.URL (assuming appropriate values are used for the first three arguments), then a client making a push handshake request to the toExternalForm() of that URL will select the argument channel for connecting the websocket push channel in the current view. It must match the PushContext#URI_PREFIX of the endpoint. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2569 + Initialize the view for the request processing lifecycle. This method must be called at the beginning of the Restore View Phase of the Request Processing Lifecycle. It is responsible for performing any per-request initialization necessary to the operation of the lifycecle. The default implementation must perform the following actions. If ExternalContext#getRequestCharacterEncoding returns null, call #calculateCharacterEncoding and pass the result, if non-null, into the ExternalContext#setRequestCharacterEncoding method. If ExternalContext#getRequestCharacterEncoding returns non-null take no action. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2570 + if a problem occurs setting the encoding, such as the UnsupportedEncodingException thrown by the underlying Jakarta Servlet or Portlet technology when the encoding is not supported. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:2571 + Remove the argument urlPattern from the thread safe Set of protected views for this application, if present in the Set. If the argument urlPattern is not present in the Set, this method has no effect. Compliant implementations must make it so a subsequent call to #getProtectedViewsUnmodifiable does not contain the argument. The runtime must support calling this method at any time after application startup. Returns true if this Set contained the argument. The default implementation takes no action and returns false. + jakarta.faces.application + ViewHandler + + + java.lang.String + + + + + + JSF:JAVADOC:2572 + Perform whatever actions are required to render the response view to the response object associated with the current FacesContext. Otherwise, the default implementation must obtain a reference to the ViewDeclarationLanguage for the viewId of the argument viewToRender and call its ViewDeclarationLanguage#renderView method, returning the result and not swallowing any exceptions thrown by that method. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:2573 + if an input/output error occurs + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + java.io.IOException + + + + + JSF:JAVADOC:2574 + if a Jakarta Servlet error occurs + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:2575 + Perform whatever actions are required to restore the view associated with the specified FacesContext and viewId. It may delegate to the restoreView of the associated StateManager to do the actual work of restoring the view. If there is no available state for the specified viewId, return null. Otherwise, the default implementation must obtain a reference to the ViewDeclarationLanguage for this viewId and call its ViewDeclarationLanguage#restoreView method, returning the result and not swallowing any exceptions thrown by that method. + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2576 + + jakarta.faces.application + ViewHandler + + + + + JSF:JAVADOC:2577 + Take any appropriate action to either immediately write out the current state information (by calling StateManager#writeState, or noting where state information should later be written. This method must do nothing if the current request is an Ajax request. When responding to Ajax requests, the state is obtained by calling StateManager#getViewState and then written into the Ajax response during final encoding (jakarta.faces.context.PartialViewContext#processPartial(jakarta.faces.event.PhaseId)) . + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2578 + if an input/output error occurs + jakarta.faces.application + ViewHandler + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + JSF:JAVADOC:2579 + The default behavior of this method is to call ViewHandler#addProtectedView on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2580 + The default behavior of this method is to call ViewHandler#calculateCharacterEncoding(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2581 + The default behavior of this method is to call ViewHandler#calculateLocale(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2582 + The default behavior of this method is to call ViewHandler#calculateRenderKitId(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2583 + The default behavior of this method is to call ViewHandler#createView(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2584 + The default behavior of this method is to call ViewHandler#deriveLogicalViewId(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2585 + The default behavior of this method is to call ViewHandler#deriveViewId(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2586 + The default behavior of this method is to call ViewHandler#getActionURL(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2587 + The default behavior of this method is to call ViewHandler#getBookmarkableURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean) on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + java.util.Map + boolean + + + + + + JSF:JAVADOC:2588 + The default behavior of this method is to call ViewHandler#getProtectedViewsUnmodifiable on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + + + JSF:JAVADOC:2589 + The default behavior of this method is to call ViewHandler#getRedirectURL(jakarta.faces.context.FacesContext, String, java.util.Map, boolean) on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + java.util.Map + boolean + + + + + + JSF:JAVADOC:2590 + The default behavior of this method is to call ViewHandler#getResourceURL(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2591 + The default behavior of this method is to call ViewHandler#getViewDeclarationLanguage on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2592 + The default behavior of this method is to call ViewHandler#getViews(FacesContext, String, ViewVisitOption...) on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + jakarta.faces.application.ViewVisitOption[] + + + + + + JSF:JAVADOC:2593 + The default behavior of this method is to call ViewHandler#getViews(FacesContext, String, int, ViewVisitOption...) on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + int + jakarta.faces.application.ViewVisitOption[] + + + + + + JSF:JAVADOC:2594 + The default behavior of this method is to call ViewHandler#getWebsocketURL(FacesContext, String) on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2595 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.application + ViewHandlerWrapper + + + + + JSF:JAVADOC:2596 + The default behavior of this method is to call ViewHandler#initView on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2597 + + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:2598 + The default behavior of this method is to call ViewHandler#removeProtectedView on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:2599 + The default behavior of this method is to call ViewHandler#renderView(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot) on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:2600 + + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + java.io.IOException + + + + + JSF:JAVADOC:2601 + + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:2602 + The default behavior of this method is to call ViewHandler#restoreView(jakarta.faces.context.FacesContext, String) on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2603 + If this view handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.application.ViewHandler + + + + + + JSF:JAVADOC:2604 + + jakarta.faces.application + ViewHandlerWrapper + + + + + JSF:JAVADOC:2605 + The default behavior of this method is to call ViewHandler#writeState(jakarta.faces.context.FacesContext) on the wrapped ViewHandler object. + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2606 + + jakarta.faces.application + ViewHandlerWrapper + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + JSF:JAVADOC:2607 + Return an actual URL instance that refers to this resource instance. + jakarta.faces.application + ViewResource + + + + + JSF:JAVADOC:2608 + + jakarta.faces.application + ViewResource + + + + + JSF:JAVADOC:2609 + + jakarta.faces.application + ViewVisitOption + + + java.lang.String + + + + + + JSF:JAVADOC:2610 + + jakarta.faces.application + ViewVisitOption + + + + + JSF:JAVADOC:2611 + Add a new ActionListener to the set of listeners interested in being notified when ActionEvents occur. + jakarta.faces.component + ActionSource + + + jakarta.faces.event.ActionListener + + + + + + JSF:JAVADOC:2612 + Return the set of registered ActionListeners for this ActionSource instance. If there are no registered listeners, a zero-length array is returned. + jakarta.faces.component + ActionSource + + + + + JSF:JAVADOC:2613 + Return a flag indicating that the default ActionListener provided by the Jakarta Faces implementation should be executed immediately (that is, during Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase. The default value for this property must be false. + jakarta.faces.component + ActionSource + + + + + JSF:JAVADOC:2614 + Remove an existing ActionListener (if any) from the set of listeners interested in being notified when ActionEvents occur. + jakarta.faces.component + ActionSource + + + jakarta.faces.event.ActionListener + + + + + + JSF:JAVADOC:2615 + Set the "immediate execution" flag for this UIComponent. + jakarta.faces.component + ActionSource + + + boolean + + + + + + JSF:JAVADOC:2616 + Return the MethodExpression pointing at the application action to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property. + jakarta.faces.component + ActionSource2 + + + + + JSF:JAVADOC:2617 + Set the MethodExpression pointing at the appication action to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property. Any method referenced by such an expression must be public, with a return type of String, and accept no parameters. + jakarta.faces.component + ActionSource2 + + + jakarta.el.MethodExpression + + + + + + JSF:JAVADOC:2618 + This method will be called by an implementation of UIComponent#invokeOnComponent and must be passed the component with the clientId given as an argument to invokeOnComponent. At the point in time when this method is called, the argument target is guaranteed to be in the proper state with respect to its ancestors in the View. + jakarta.faces.component + ContextCallback + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:2619 + Returns the public identifier of the document, or null if there is none. For example, "-//W3C//DTD XHTML 1.1//EN". + jakarta.faces.component + Doctype + + + + + JSF:JAVADOC:2620 + Returns the name of the first element in the document, never null. For example, "html". + jakarta.faces.component + Doctype + + + + + JSF:JAVADOC:2621 + Returns the system identifier of the document, or null if there is none. For example, "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd". + jakarta.faces.component + Doctype + + + + + JSF:JAVADOC:2622 + Add a Validator instance to the set associated with this component. + jakarta.faces.component + EditableValueHolder + + + jakarta.faces.validator.Validator + + + + + + JSF:JAVADOC:2623 + Add a new ValueChangeListener to the set of listeners interested in being notified when ValueChangeEvents occur. + jakarta.faces.component + EditableValueHolder + + + jakarta.faces.event.ValueChangeListener + + + + + + JSF:JAVADOC:2624 + Return the submittedValue value of this component. This method should only be used by the encodeBegin() and/or encodeEnd() methods of this component, or its corresponding Renderer. The action taken based on whether the value is null, empty, or non-null is determined based on the value of the jakarta.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULLcontext-param. + jakarta.faces.component + EditableValueHolder + + + + + JSF:JAVADOC:2625 + Return the set of registered Validators for this component instance. If there are no registered validators, a zero-length array is returned. + jakarta.faces.component + EditableValueHolder + + + + + JSF:JAVADOC:2626 + Return the set of registered ValueChangeListeners for this component instance. If there are no registered listeners, a zero-length array is returned. + jakarta.faces.component + EditableValueHolder + + + + + JSF:JAVADOC:2627 + Return the "immediate" state for this component. + jakarta.faces.component + EditableValueHolder + + + + + JSF:JAVADOC:2628 + Return the "local value set" state for this component. Calls to setValue() automatically reset this property to true. + jakarta.faces.component + EditableValueHolder + + + + + JSF:JAVADOC:2629 + Return the "required field" state for this component. + jakarta.faces.component + EditableValueHolder + + + + + JSF:JAVADOC:2630 + Return a flag indicating whether the local value of this component is valid (no conversion error has occurred). + jakarta.faces.component + EditableValueHolder + + + + + JSF:JAVADOC:2631 + Remove a Validator instance from the set associated with this component, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + EditableValueHolder + + + jakarta.faces.validator.Validator + + + + + + JSF:JAVADOC:2632 + Remove an existing ValueChangeListener (if any) from the set of listeners interested in being notified when ValueChangeEvents occur. + jakarta.faces.component + EditableValueHolder + + + jakarta.faces.event.ValueChangeListener + + + + + + JSF:JAVADOC:2633 + Convenience method to reset this component's value to the un-initialized state. + jakarta.faces.component + EditableValueHolder + + + + + JSF:JAVADOC:2634 + Set the "immediate" state for this component. When set to true, the component's value will be converted and validated immediately in the Apply Request Values phase, and ValueChangeEvents will be delivered in that phase as well. The default value for this property must be false. + jakarta.faces.component + EditableValueHolder + + + boolean + + + + + + JSF:JAVADOC:2635 + Sets the "local value set" state for this component. + jakarta.faces.component + EditableValueHolder + + + boolean + + + + + + JSF:JAVADOC:2636 + Set the "required field" state for this component. + jakarta.faces.component + EditableValueHolder + + + boolean + + + + + + JSF:JAVADOC:2637 + Set the submittedValue value of this component. This method should only be used by the decode() and validate() method of this component, or its corresponding Renderer. The action taken based on whether the value is null, empty, or non-null is determined based on the value of the jakarta.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULLcontext-param. + jakarta.faces.component + EditableValueHolder + + + java.lang.Object + + + + + + JSF:JAVADOC:2638 + Set a flag indicating whether the local value of this component is valid (no conversion error has occurred). + jakarta.faces.component + EditableValueHolder + + + boolean + + + + + + JSF:JAVADOC:2639 + If the value of this attribute is true, the runtime must create a Facelet tag handler, that extends from jakarta.faces.view.facelets.ComponentHandler, suitable for use in pages under the tag library with namespace given by the value of the #namespace attribute. + jakarta.faces.component + FacesComponent + + + + + JSF:JAVADOC:2640 + If the value of the #createTag attribute is true, the value of this attribute is taken to be the tag library namespace into which this component is placed. + jakarta.faces.component + FacesComponent + + + + + JSF:JAVADOC:2641 + If the value of the #createTag attribute is true, the runtime must use this value as the tag name for including an instance of the component annotated with this annotation in a view. If this attribute is not specified on a usage of this annotation, the simple name of the class on which this annotation is declared, with the first character lowercased, is taken to be the value. + jakarta.faces.component + FacesComponent + + + + + JSF:JAVADOC:2642 + The value of this annotation attribute is taken to be the component-type with which instances of this class of component can be instantiated by calling jakarta.faces.application.Application#createComponent(java.lang.String). If no value is specified, or the value is null, the value is taken to be the return of calling getSimpleName on the class to which this annotation is attached and lowercasing the first character. If more than one component with this derived name is found, the results are undefined. + jakarta.faces.component + FacesComponent + + + + + JSF:JAVADOC:2643 + Reset the PartialStateHolder to a non-delta tracking state. + jakarta.faces.component + PartialStateHolder + + + + + JSF:JAVADOC:2644 + Return true if delta state changes are being tracked, otherwise false + jakarta.faces.component + PartialStateHolder + + + + + JSF:JAVADOC:2645 + The runtime must ensure that the #markInitialState method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state. The implementor of the interface must ensure that #initialStateMarked returns true from the time markInitialState() is called until #clearInitialState is called, after which time initialStateMarked() must return false. Also, during the time that the instance returns true from initialStateMarked(), the implementation must return only the state that has changed in its implementation of StateHolder#saveState. + jakarta.faces.component + PartialStateHolder + + + + + JSF:JAVADOC:2646 + Store the specified value in a List that is internal to the StateHelper. It's important to note for delta tracking that any modifications to the internal List be made through this method or StateHelper#remove(java.io.Serializable, Object). + jakarta.faces.component + StateHelper + + + java.io.Serializable + java.lang.Object + + + + + + JSF:JAVADOC:2647 + Attempts to find a value associated with the specified key, using the value expression collection from the component if no such value is found. + jakarta.faces.component + StateHelper + + + java.io.Serializable + + + + + + JSF:JAVADOC:2648 + Performs the same logic as #eval(java.io.Serializable) } but if no value is found, this will return the specified defaultValue + jakarta.faces.component + StateHelper + + + java.io.Serializable + java.lang.Object + + + + + + JSF:JAVADOC:2649 + Performs the same logic as #eval(java.io.Serializable) } but if no value is found, this will return the return-value of the defaultValueSupplier + jakarta.faces.component + StateHelper + + + java.io.Serializable + java.util.function.Supplier + + + + + + JSF:JAVADOC:2650 + Return the value currently associated with the specified key if any. + jakarta.faces.component + StateHelper + + + java.io.Serializable + + + + + + JSF:JAVADOC:2651 + Return the previously stored value and store the specified key/value pair. This is intended to store data that would otherwise reside in an instance variable on the component. + jakarta.faces.component + StateHelper + + + java.io.Serializable + java.lang.Object + + + + + + JSF:JAVADOC:2652 + Store the specified mapKey/value in a Map that is internal to the helper, and return the previously stored value. The Map will then be associated with key. It's important to note for delta tracking that any modifications to the internal Map be made through this method or StateHelper#remove(java.io.Serializable, Object). + jakarta.faces.component + StateHelper + + + java.io.Serializable + java.lang.String + java.lang.Object + + + + + + JSF:JAVADOC:2653 + Remove the key/value pair from the helper, returning the value previously stored under this key. + jakarta.faces.component + StateHelper + + + java.io.Serializable + + + + + + JSF:JAVADOC:2654 + Remove a value from the inner data structure. Look in the inner data structure for the value at the given key. If the value is a Map, remove and return the value under the key given by the valueOrKey argument. If the value is a Collection, simply remove the value given by the argument valueOrKey and return null. + jakarta.faces.component + StateHelper + + + java.io.Serializable + java.lang.Object + + + + + + JSF:JAVADOC:2655 + If true, the Object implementing this interface must not participate in state saving or restoring. + jakarta.faces.component + StateHolder + + + + + JSF:JAVADOC:2656 + Perform any processing required to restore the state from the entries in the state Object. If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the #restoreState method on all those instances as well. If the state argument is null, take no action and return. + jakarta.faces.component + StateHolder + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:2657 + Gets the state of the instance as a Serializable Object. If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the #saveState method on all those instances as well. This method must not save the state of children and facets. That is done via the jakarta.faces.application.StateManager This method must not alter the state of the implementing object. In other words, after executing this code: Object state = component.saveState(facesContext); component should be the same as before executing it. The return from this method must be Serializable + jakarta.faces.component + StateHolder + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2658 + Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring. + jakarta.faces.component + StateHolder + + + boolean + + + + + + JSF:JAVADOC:2659 + Return the value currently associated with the specified key if any. + jakarta.faces.component + TransientStateHelper + + + java.lang.Object + + + + + + JSF:JAVADOC:2660 + Performs the same logic as #getTransient } but if no value is found, this will return the specified defaultValue + jakarta.faces.component + TransientStateHelper + + + java.lang.Object + java.lang.Object + + + + + + JSF:JAVADOC:2661 + Return the previously stored value and store the specified key/value pair. This is intended to store data that would otherwise reside in an instance variable on the component. + jakarta.faces.component + TransientStateHelper + + + java.lang.Object + java.lang.Object + + + + + + JSF:JAVADOC:2662 + Restore the "transient state" using the object passed as state. If the state argument is null clear any previous transient state if any and return. + jakarta.faces.component + TransientStateHolder + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:2663 + Return the object containing related "transient states". that could be used later to restore the "transient state". + jakarta.faces.component + TransientStateHolder + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2664 + Get the component family. + jakarta.faces.component + UIColumn + + + + + JSF:JAVADOC:2665 + Return the footer facet of the column (if any). A convenience method for getFacet("footer"). + jakarta.faces.component + UIColumn + + + + + JSF:JAVADOC:2666 + Return the header facet of the column (if any). A convenience method for getFacet("header"). + jakarta.faces.component + UIColumn + + + + + JSF:JAVADOC:2667 + Set the footer facet of the column. A convenience method for getFacets().put("footer", footer). + jakarta.faces.component + UIColumn + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:2668 + Set the header facet of the column. A convenience method for getFacets().put("header", header). + jakarta.faces.component + UIColumn + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:2669 + Create a new UIColumn instance with default property values. + jakarta.faces.component + UIColumn + + + + + JSF:JAVADOC:2670 + In addition to to the default UIComponent#broadcast processing, pass the ActionEvent being broadcast to the method referenced by actionListener (if any), and to the default ActionListener registered on the jakarta.faces.application.Application. + jakarta.faces.component + UICommand + + + jakarta.faces.event.FacesEvent + + + + + + JSF:JAVADOC:2671 + Signal the Jakarta Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UICommand + + + jakarta.faces.event.FacesEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:2672 + Return the MethodExpression pointing at the application action to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property. + jakarta.faces.component + UICommand + + + + + JSF:JAVADOC:2673 + + jakarta.faces.component + UICommand + + + + + JSF:JAVADOC:2674 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UICommand + + + + + JSF:JAVADOC:2675 + Returns the value property of the UICommand. This is most often rendered as a label. + jakarta.faces.component + UICommand + + + + + JSF:JAVADOC:2676 + The immediate flag. + jakarta.faces.component + UICommand + + + + + JSF:JAVADOC:2677 + Intercept queueEvent and take the following action. If the event is an ActionEvent, obtain the UIComponent instance from the event. If the component is an ActionSource obtain the value of its "immediate" property. If it is true, mark the phaseId for the event to be PhaseId.APPLY_REQUEST_VALUES otherwise, mark the phaseId to be PhaseId.INVOKE_APPLICATION. The event must be passed on to super.queueEvent() before returning from this method. + jakarta.faces.component + UICommand + + + jakarta.faces.event.FacesEvent + + + + + + JSF:JAVADOC:2678 + Set the MethodExpression pointing at the appication action to be invoked, if this UIComponent is activated by the user, during the Apply Request Values or Invoke Application phase of the request processing lifecycle, depending on the value of the immediate property. Any method referenced by such an expression must be public, with a return type of String, and accept no parameters. + jakarta.faces.component + UICommand + + + jakarta.el.MethodExpression + + + + + + JSF:JAVADOC:2679 + + jakarta.faces.component + UICommand + + + boolean + + + + + + JSF:JAVADOC:2680 + Sets the value property of the UICommand. This is most often rendered as a label. + jakarta.faces.component + UICommand + + + java.lang.Object + + + + + + JSF:JAVADOC:2681 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type. Listeners are called in the order in which they were added. If the event is an instance of jakarta.faces.event.BehaviorEvent and the current component is the source of the event call jakarta.faces.event.BehaviorEvent#getBehavior to get the jakarta.faces.component.behavior.Behavior for the event. Call jakarta.faces.component.behavior.Behavior#broadcast(jakarta.faces.event.BehaviorEvent) on the Behavior instance. + jakarta.faces.component + UIComponent + + + jakarta.faces.event.FacesEvent + + + + + + JSF:JAVADOC:2682 + Signal the Jakarta Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UIComponent + + + jakarta.faces.event.FacesEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:2683 + An implementation of PartialStateHolder#clearInitialState, this method is called by the runtime to tell the instance to stop tracking state changes. + jakarta.faces.component + UIComponent + + + + + JSF:JAVADOC:2684 + If this component returns true from #isRendered, take the following action. Render this component and all its children that return true from isRendered(), regardless of the value of the #getRendersChildren flag. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2685 + if an input/output error occurs while rendering + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + JSF:JAVADOC:2686 + Return a mutable Map representing the attributes (and properties, see below) associated wth this UIComponent, keyed by attribute name (which must be a String). The returned implementation must support all of the standard and optional Map methods, plus support the following additional requirements: The Map implementation must implement the java.io.Serializable interface. Any attempt to add a null key or value must throw a NullPointerException. Any attempt to add a key that is not a String must throw a ClassCastException. If the attribute name specified as a key matches a property of this UIComponent's implementation class, the following methods will have special behavior: containsKey - Return false. get() - If the property is readable, call the getter method and return the returned value (wrapping primitive values in their corresponding wrapper classes); otherwise throw IllegalArgumentException. put() - If the property is writeable, call the setter method to set the corresponding value (unwrapping primitive values in their corresponding wrapper classes). If the property is not writeable, or an attempt is made to set a property of primitive type to null, throw IllegalArgumentException. remove - Throw IllegalArgumentException. + jakarta.faces.component + UIComponent + + + + + JSF:JAVADOC:2687 + Return a mutable List representing the child UIComponents associated with this component. The returned implementation must support all of the standard and optional List methods, plus support the following additional requirements: The List implementation must implement the java.io.Serializable interface. Any attempt to add a null must throw a NullPointerException Any attempt to add an object that does not implement UIComponent must throw a ClassCastException. Whenever a new child component is added, the parent property of the child must be set to this component instance. If the parent property of the child was already non-null, the child must first be removed from its previous parent (where it may have been either a child or a facet). Whenever an existing child component is removed, the parent property of the child must be set to null. After the child component has been added to the view, jakarta.faces.application.Application#publishEvent must be called, passing jakarta.faces.event.PostAddToViewEvent.class as the first argument and the newly added component as the second argument if any the following cases are true. jakarta.faces.context.FacesContext#getCurrentPhaseId returns jakarta.faces.event.PhaseId#RESTORE_VIEW and partial state saving is enabled. jakarta.faces.context.FacesContext#isPostback returns false and jakarta.faces.context.FacesContext#getCurrentPhaseId returns something other than jakarta.faces.event.PhaseId#RESTORE_VIEW + jakarta.faces.component + UIComponent + + + + + JSF:JAVADOC:2688 + Enable Jakarta Expression Language to access the clientId of a component. This is particularly useful in combination with the component and cc implicit objects. A default implementation is provided that simply calls FacesContext#getCurrentInstance and then calls through to #getClientId(FacesContext). + jakarta.faces.component + UIComponent + + + + + JSF:JAVADOC:2689 + Finds the nearest composite component parent of the specified component. + jakarta.faces.component + UIComponent + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:2690 + Allow components that implement NamingContainer to selectively disable prepending their clientId to their descendent's clientIds by breaking the prepending logic into a separately callable method. See #getClientId for usage. By default, this method will call through to #getClientId and return the result. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2691 + Return the UIComponent instance that is currently processing. This is equivalent to evaluating the Jakarta Expression Language expression "#{component}" and doing a getValue operation on the resultant ValueExpression. This method must return null if there is no currently processing UIComponent + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2692 + Return the closest ancestor component, relative to the component returned from #getCurrentComponent, that is a composite component, or null if no such component exists. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2693 + Return the number of facet UIComponents that are associated with this UIComponent. If there are no facets, this method must return 0. The method must not cause the creation of a facet component map. For backwards compatability with classes that extend UIComponent directly, a default implementation is provided that simply calls #getFacets and then calls the size() method on the returned Map. A more optimized version of this method is provided in UIComponentBase#getFacetCount. + jakarta.faces.component + UIComponent + + + + + JSF:JAVADOC:2694 + Return a mutable Map representing the facet UIComponents associated with this UIComponent, keyed by facet name (which must be a String). The returned implementation must support all of the standard and optional Map methods, plus support the following additional requirements: The Map implementation must implement the java.io.Serializable interface. Any attempt to add a null key or value must throw a NullPointerException. Any attempt to add a key that is not a String must throw a ClassCastException. Any attempt to add a value that is not a UIComponent must throw a ClassCastException. Whenever a new facet UIComponent is added: The parent property of the component must be set to this component instance. If the parent property of the component was already non-null, the component must first be removed from its previous parent (where it may have been either a child or a facet). Whenever an existing facet UIComponent is removed: The parent property of the facet must be set to null. + jakarta.faces.component + UIComponent + + + + + JSF:JAVADOC:2695 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UIComponent + + + + + JSF:JAVADOC:2696 + Return the component identifier of this UIComponent. + jakarta.faces.component + UIComponent + + + + + JSF:JAVADOC:2697 + This implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. UIComponentBase provides the implementation of this method. + jakarta.faces.component + UIComponent + + + java.lang.Class + + + + + + JSF:JAVADOC:2698 + Starting with "this", return the closest component in the ancestry that is a NamingContainer or null if none can be found. + jakarta.faces.component + UIComponent + + + + + JSF:JAVADOC:2699 + This is a convenience method that simply calls #getPassThroughAttributes(boolean), passing true as the argument. This method must never return null. + jakarta.faces.component + UIComponent + + + + + JSF:JAVADOC:2700 + This method has the same specification as #getPassThroughAttributes() except that it is allowed to return null if and only if the argument create is false and no pass through attribute data structure exists for this instance. The returned Map implementation must support all of the standard and optional Map methods, plus support the following additional requirements. The map must be stored in using #getStateHelper. The Map implementation must implement java.io.Serializable. Any attempt to add a null key or value must throw a NullPointerException. Any attempt to add a key that is not a String must throw an IllegalArgumentException. For backward compatibility with components that extend directly from this class, a default implementation is provided that returns the empty map. + jakarta.faces.component + UIComponent + + + boolean + + + + + + JSF:JAVADOC:2701 + Return a Map of the ResourceBundle for this component. A component may have a ResourceBundle associated with it. This bundle may contain localized properties relating to instances of this component. The default implementation first looks for a ResourceBundle with a base name equal to the fully qualified class name of the current UIComponent this and Locale equal to the Locale of the current UIViewRoot. If no such bundle is found, and the component is a composite component, let resourceName be the resourceName of the Resource for this composite component, replacing the file extension with ".properties". Let libraryName be the libraryName of the the Resource for this composite component. Call jakarta.faces.application.ResourceHandler#createResource(java.lang.String,java.lang.String), passing the derived resourceName and libraryName. Note that this will automatically allow for the localization of the ResourceBundle due to the localization facility implemented in createResource, which is specified in section 2.6.1.3 "Resource Identifiers" of the Jakarta Faces Specification Document. If the resultant Resource exists and can be found, the InputStream for the resource is used to create a ResourceBundle. If either of the two previous steps for obtaining the ResourceBundle for this component is successful, the ResourceBundle is wrapped in a Map and returned. Otherwise Collections.EMPTY_MAP is returned. + jakarta.faces.component + UIComponent + + + + + JSF:JAVADOC:2702 + Return the TransientStateHelper instance for this UIComponent instance. The default implementation simply calls through to #getTransientStateHelper(boolean) passing true as the argument. + jakarta.faces.component + UIComponent + + + + + JSF:JAVADOC:2703 + Return the TransientStateHelper instance for this UIComponent instance. + jakarta.faces.component + UIComponent + + + boolean + + + + + + JSF:JAVADOC:2704 + Return the ValueExpression used to calculate the value for the specified attribute or property name, if any. This method must be overridden and implemented for components that comply with Jakarta Faces 1.2 and later. + jakarta.faces.component + UIComponent + + + java.lang.String + + + + + + JSF:JAVADOC:2705 + An implementation of PartialStateHolder#initialStateMarked, this method is called by the runtime to test if the PartialStateHolder#markInitialState method was called. + jakarta.faces.component + UIComponent + + + + + JSF:JAVADOC:2706 + Starting at this component in the View hierarchy, search for a component with a clientId equal to the argument clientId and, if found, call the ContextCallback#invokeContextCallback method on the argument callback, passing the current FacesContext and the found component as arguments. This method is similar to #findComponent but it does not support the leading UINamingContainer#getSeparatorChar syntax for searching from the root of the View. The default implementation will first check if this.getClientId() is equal to the argument clientId. If so, first call #pushComponentToEL, then call the ContextCallback#invokeContextCallback method on the argument callback, passing through the FacesContext argument and passing this as the component argument. Then call #popComponentFromEL. If an Exception is thrown by the callback, wrap it in a FacesException and re-throw it. Otherwise, return true. Otherwise, for each component returned by #getFacetsAndChildren, call invokeOnComponent() passing the arguments to this method, in order. The first time invokeOnComponent() returns true, abort traversing the rest of the Iterator and return true. When calling ContextCallback#invokeContextCallback the implementation of this method must guarantee that the state of the component passed to the callback correctly reflects the component's position in the View hierarchy with respect to any state found in the argument clientId. For example, an iterating component such as UIData will need to set its row index to correctly reflect the argument clientId before finding the appropriate child component backed by the correct row. When the callback returns, either normally or by throwing an Exception the implementation of this method must restore the state of the view to the way it was before invoking the callback. If none of the elements from #getFacetsAndChildren returned true from invokeOnComponent(), return false. Simple usage example to find a component by clientId. private UIComponent found = null; private void doFind(FacesContext context, String clientId) { context.getViewRoot().invokeOnComponent(context, clientId, new ContextCallback() { public void invokeContextCallback(FacesContext context, UIComponent component) { found = component; } }); } + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + java.lang.String + jakarta.faces.component.ContextCallback + + + + + + JSF:JAVADOC:2707 + if the argument Callback throws an Exception, it is wrapped in a FacesException and re-thrown. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + java.lang.String + jakarta.faces.component.ContextCallback + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:2708 + Return true if component is a composite component, otherwise false. + jakarta.faces.component + UIComponent + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:2709 + Return true if this component is within the view hierarchy otherwise false + jakarta.faces.component + UIComponent + + + + + JSF:JAVADOC:2710 + An implementation of PartialStateHolder#markInitialState, this method is called by the runtime to indicate that the instance should start tracking changes to its state. + jakarta.faces.component + UIComponent + + + + + JSF:JAVADOC:2711 + Pop the current UIComponent from the FacesContext attributes map so that the previous UIComponent, if any, becomes the current component. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2712 + The default implementation performs the following action. If the argument event is an instance of PostRestoreStateEvent, call this.#getValueExpression passing the literal string #8220;binding #8221;, without the quotes, as the argument. If the result is non-null, set the value of the ValueExpression to be this. + jakarta.faces.component + UIComponent + + + jakarta.faces.event.ComponentSystemEvent + + + + + + JSF:JAVADOC:2713 + + jakarta.faces.component + UIComponent + + + jakarta.faces.event.ComponentSystemEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:2714 + Perform the component tree processing required by the Restore View phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the restoreState() method of this component. Call UIComponent#pushComponentToEL. Call the processRestoreState() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). After returning from the processRestoreState() method on a child or facet, call UIComponent#popComponentFromEL This method may not be called if the state saving method is set to server. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:2715 + Perform the component tree processing required by the state saving portion of the Render Response phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. consult the transient property of this component. If true, just return null. Call #pushComponentToEL. Call the processSaveState() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(), skipping children and facets that are transient. Ensure that #popComponentFromEL is called correctly after each child or facet. Call the saveState() method of this component. Encapsulate the child state and your state into a Serializable Object and return it. This method may not be called if the state saving method is set to server. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2716 + Push the current UIComponent this to the FacesContext attribute map saving the previous UIComponent for a subsequent call to #popComponentFromEL. This method and popComponentFromEL() form the basis for the contract that enables the Jakarta Expression Language Expression "#{component}" to resolve to the "current" component that is being processed in the lifecycle. The requirements for when pushComponentToEL() and popComponentFromEL() must be called are specified as needed in the javadoc for this class. After pushComponentToEL() returns, a call to #getCurrentComponent must return this UIComponent instance until popComponentFromEL() is called, after which point the previous UIComponent instance will be returned from getCurrentComponent() + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:2717 + Queue an event for broadcast at the end of the current request processing lifecycle phase. The default implementation in UIComponentBase must delegate this call to the queueEvent() method of the parent UIComponent. + jakarta.faces.component + UIComponent + + + jakarta.faces.event.FacesEvent + + + + + + JSF:JAVADOC:2718 + For components that need to support the concept of transient state, this method will restore any state saved on a prior call to #saveTransientState. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:2719 + For components that need to support the concept of transient state, this method will save any state that is known to be transient in nature. + jakarta.faces.component + UIComponent + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2720 + Set the component identifier of this UIComponent (if any). Component identifiers must obey the following syntax restrictions: Must not be a zero-length String. First character must be a letter or an underscore ('_'). Subsequent characters must be a letter, a digit, an underscore ('_'), or a dash ('-'). Component identifiers must also obey the following semantic restrictions (note that this restriction is NOT enforced by the setId() implementation): The specified identifier must be unique among all the components (including facets) that are descendents of the nearest ancestor UIComponent that is a NamingContainer, or within the scope of the entire component tree if there is no such ancestor that is a NamingContainer. + jakarta.faces.component + UIComponent + + + java.lang.String + + + + + + JSF:JAVADOC:2721 + Updates the status as to whether or not this component is currently within the view hierarchy. This method must never be called by developers; a UIComponent's internal implementation will call it as components are added to or removed from a parent's child List or facet Map. + jakarta.faces.component + UIComponent + + + boolean + + + + + + JSF:JAVADOC:2722 + Set the ValueExpression used to calculate the value for the specified attribute or property name, if any. The implementation must call ValueExpression#isLiteralText on the argument expression. If isLiteralText() returns true, invoke ValueExpression#getValue on the argument expression and pass the result as the value parameter in a call to this.#getAttributes().put(name, value) where name is the argument name. If an exception is thrown as a result of calling ValueExpression#getValue, wrap it in a jakarta.faces.FacesException and re-throw it. If isLiteralText() returns false, simply store the un-evaluated expression argument in the collection of ValueExpressions under the key given by the argument name. This method must be overridden and implemented for components that comply with Jakarta Faces 1.2 and later. + jakarta.faces.component + UIComponent + + + java.lang.String + jakarta.el.ValueExpression + + + + + + JSF:JAVADOC:2723 + This implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. UIComponentBase provides the implementation of this method. + jakarta.faces.component + UIComponent + + + java.lang.Class + jakarta.faces.event.ComponentSystemEventListener + + + + + + JSF:JAVADOC:2724 + + jakarta.faces.component + UIComponent + + + + + JSF:JAVADOC:2725 + This implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. UIComponentBase provides the implementation of this method. + jakarta.faces.component + UIComponent + + + java.lang.Class + jakarta.faces.event.ComponentSystemEventListener + + + + + + JSF:JAVADOC:2726 + Perform a tree visit starting at this node in the tree. UIComponent.visitTree() implementations do not invoke the VisitCallback directly, but instead call VisitContext#invokeVisitCallback to invoke the callback. This allows VisitContext implementations to provide optimized tree traversals, for example by only calling the VisitCallback for a subset of components. UIComponent.visitTree() implementations must call UIComponent.pushComponentToEL() before performing the visit and UIComponent.popComponentFromEL() after the visit. + jakarta.faces.component + UIComponent + + + jakarta.faces.component.visit.VisitContext + jakarta.faces.component.visit.VisitCallback + + + + + + JSF:JAVADOC:2727 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#addClientBehavior. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component + UIComponentBase + + + java.lang.String + jakarta.faces.component.behavior.ClientBehavior + + + + + + JSF:JAVADOC:2728 + Broadcast the specified FacesEvent to all registered event listeners who have expressed an interest in events of this type. Listeners are called in the order in which they were added. If the event is an instance of jakarta.faces.event.BehaviorEvent and the current component is the source of the event call jakarta.faces.event.BehaviorEvent#getBehavior to get the jakarta.faces.component.behavior.Behavior for the event. Call jakarta.faces.component.behavior.Behavior#broadcast(jakarta.faces.event.BehaviorEvent) on the Behavior instance. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.event.FacesEvent + + + + + + JSF:JAVADOC:2729 + Signal the Jakarta Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UIComponentBase + + + jakarta.faces.event.FacesEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:2730 + For each of the attached objects on this instance that implement PartialStateHolder, call PartialStateHolder#clearInitialState on the attached object. + jakarta.faces.component + UIComponentBase + + + + + JSF:JAVADOC:2731 + Return a mutable Map representing the attributes (and properties, see below) associated wth this UIComponent, keyed by attribute name (which must be a String). The returned implementation must support all of the standard and optional Map methods, plus support the following additional requirements: The Map implementation must implement the java.io.Serializable interface. Any attempt to add a null key or value must throw a NullPointerException. Any attempt to add a key that is not a String must throw a ClassCastException. If the attribute name specified as a key matches a property of this UIComponent's implementation class, the following methods will have special behavior: containsKey - Return false. get() - If the property is readable, call the getter method and return the returned value (wrapping primitive values in their corresponding wrapper classes); otherwise throw IllegalArgumentException. put() - If the property is writeable, call the setter method to set the corresponding value (unwrapping primitive values in their corresponding wrapper classes). If the property is not writeable, or an attempt is made to set a property of primitive type to null, throw IllegalArgumentException. remove - Throw IllegalArgumentException. + jakarta.faces.component + UIComponentBase + + + + + JSF:JAVADOC:2732 + Return a mutable List representing the child UIComponents associated with this component. The returned implementation must support all of the standard and optional List methods, plus support the following additional requirements: The List implementation must implement the java.io.Serializable interface. Any attempt to add a null must throw a NullPointerException Any attempt to add an object that does not implement UIComponent must throw a ClassCastException. Whenever a new child component is added, the parent property of the child must be set to this component instance. If the parent property of the child was already non-null, the child must first be removed from its previous parent (where it may have been either a child or a facet). Whenever an existing child component is removed, the parent property of the child must be set to null. After the child component has been added to the view, jakarta.faces.application.Application#publishEvent must be called, passing jakarta.faces.event.PostAddToViewEvent.class as the first argument and the newly added component as the second argument if any the following cases are true. jakarta.faces.context.FacesContext#getCurrentPhaseId returns jakarta.faces.event.PhaseId#RESTORE_VIEW and partial state saving is enabled. jakarta.faces.context.FacesContext#isPostback returns false and jakarta.faces.context.FacesContext#getCurrentPhaseId returns something other than jakarta.faces.event.PhaseId#RESTORE_VIEW + jakarta.faces.component + UIComponentBase + + + + + JSF:JAVADOC:2733 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getClientBehaviors. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must add an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component + UIComponentBase + + + + + JSF:JAVADOC:2734 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component + UIComponentBase + + + + + JSF:JAVADOC:2735 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component + UIComponentBase + + + + + JSF:JAVADOC:2736 + Return the number of facet UIComponents that are associated with this UIComponent. If there are no facets, this method must return 0. The method must not cause the creation of a facet component map. For backwards compatability with classes that extend UIComponent directly, a default implementation is provided that simply calls #getFacets and then calls the size() method on the returned Map. A more optimized version of this method is provided in UIComponentBase#getFacetCount. + jakarta.faces.component + UIComponentBase + + + + + JSF:JAVADOC:2737 + Return a mutable Map representing the facet UIComponents associated with this UIComponent, keyed by facet name (which must be a String). The returned implementation must support all of the standard and optional Map methods, plus support the following additional requirements: The Map implementation must implement the java.io.Serializable interface. Any attempt to add a null key or value must throw a NullPointerException. Any attempt to add a key that is not a String must throw a ClassCastException. Any attempt to add a value that is not a UIComponent must throw a ClassCastException. Whenever a new facet UIComponent is added: The parent property of the component must be set to this component instance. If the parent property of the component was already non-null, the component must first be removed from its previous parent (where it may have been either a child or a facet). Whenever an existing facet UIComponent is removed: The parent property of the facet must be set to null. + jakarta.faces.component + UIComponentBase + + + + + JSF:JAVADOC:2738 + Return the component identifier of this UIComponent. + jakarta.faces.component + UIComponentBase + + + + + JSF:JAVADOC:2739 + Return the SystemEventListener instances registered on this UIComponent instance that are interested in events of type eventClass. + jakarta.faces.component + UIComponentBase + + + java.lang.Class + + + + + + JSF:JAVADOC:2740 + This method has the same specification as #getPassThroughAttributes() except that it is allowed to return null if and only if the argument create is false and no pass through attribute data structure exists for this instance. The returned Map implementation must support all of the standard and optional Map methods, plus support the following additional requirements. The map must be stored in using #getStateHelper. The Map implementation must implement java.io.Serializable. Any attempt to add a null key or value must throw a NullPointerException. Any attempt to add a key that is not a String must throw an IllegalArgumentException. For backward compatibility with components that extend directly from this class, a default implementation is provided that returns the empty map. + jakarta.faces.component + UIComponentBase + + + boolean + + + + + + JSF:JAVADOC:2741 + + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + java.lang.String + jakarta.faces.component.ContextCallback + + + + + + JSF:JAVADOC:2742 + {@inheritDoc} + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + java.lang.String + jakarta.faces.component.ContextCallback + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:2743 + + jakarta.faces.component + UIComponentBase + + + + + JSF:JAVADOC:2744 + For each of the attached objects on this instance that implement PartialStateHolder, call PartialStateHolder#markInitialState on the attached object. + jakarta.faces.component + UIComponentBase + + + + + JSF:JAVADOC:2745 + Perform the component tree processing required by the Restore View phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. Call the restoreState() method of this component. Call UIComponent#pushComponentToEL. Call the processRestoreState() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(). After returning from the processRestoreState() method on a child or facet, call UIComponent#popComponentFromEL This method may not be called if the state saving method is set to server. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:2746 + Perform the component tree processing required by the state saving portion of the Render Response phase of the request processing lifecycle for all facets of this component, all children of this component, and this component itself, as follows. consult the transient property of this component. If true, just return null. Call #pushComponentToEL. Call the processSaveState() method of all facets and children of this UIComponent in the order determined by a call to getFacetsAndChildren(), skipping children and facets that are transient. Ensure that #popComponentFromEL is called correctly after each child or facet. Call the saveState() method of this component. Encapsulate the child state and your state into a Serializable Object and return it. This method may not be called if the state saving method is set to server. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2747 + Queue an event for broadcast at the end of the current request processing lifecycle phase. The default implementation in UIComponentBase must delegate this call to the queueEvent() method of the parent UIComponent. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.event.FacesEvent + + + + + + JSF:JAVADOC:2748 + This method is called by UIComponent subclasses that need to restore the objects they saved using #saveAttachedState. This method is tightly coupled with #saveAttachedState. This method supports restoring all attached objects types supported by #saveAttachedState. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:2749 + if the object is not previously returned by #saveAttachedState. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + java.lang.Object + + java.lang.IllegalStateException + + + + + JSF:JAVADOC:2750 + + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:2751 + This method is called by UIComponent subclasses that want to save one or more attached objects. It is a convenience method that does the work of saving attached objects that may or may not implement the StateHolder interface. Using this method implies the use of #restoreAttachedState to restore the attached objects. This method supports saving attached objects of the following type: Objects, null values, and Collections of these objects. If any contained objects are not Collections and do not implement StateHolder, they must have zero-argument public constructors. The exact structure of the returned object is undefined and opaque, but will be serializable. + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:2752 + + jakarta.faces.component + UIComponentBase + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2753 + Set the component identifier of this UIComponent (if any). Component identifiers must obey the following syntax restrictions: Must not be a zero-length String. First character must be a letter or an underscore ('_'). Subsequent characters must be a letter, a digit, an underscore ('_'), or a dash ('-'). Component identifiers must also obey the following semantic restrictions (note that this restriction is NOT enforced by the setId() implementation): The specified identifier must be unique among all the components (including facets) that are descendents of the nearest ancestor UIComponent that is a NamingContainer, or within the scope of the entire component tree if there is no such ancestor that is a NamingContainer. + jakarta.faces.component + UIComponentBase + + + java.lang.String + + + + + + JSF:JAVADOC:2754 + + jakarta.faces.component + UIComponentBase + + + boolean + + + + + + JSF:JAVADOC:2755 + Install the listener instance referenced by argument componentListener as a listener for events of type eventClass originating from this specific instance of UIComponent. The default implementation creates an inner SystemEventListener instance that wraps argument componentListener as the listener argument. This inner class must call through to the argument componentListener in its implementation of SystemEventListener#processEvent and its implementation of SystemEventListener#isListenerForSource must return true if the instance class of this UIComponent is assignable from the argument to isListenerForSource. The listener instance referenced by argument componentListener may not already be installed as a listener for events of type eventClass originating from this specific instance of UIComponent. When doing the comparison to determine if an existing listener is equal to the argument componentListener, the equals() method on the existing listener must be invoked, passing the argument componentListener, rather than the other way around. + jakarta.faces.component + UIComponentBase + + + java.lang.Class + jakarta.faces.event.ComponentSystemEventListener + + + + + + JSF:JAVADOC:2756 + Remove the listener instance referenced by argument componentListener as a listener for events of type eventClass originating from this specific instance of UIComponent. When doing the comparison to determine if an existing listener is equal to the argument componentListener (and thus must be removed), the equals() method on the existing listener must be invoked, passing the argument componentListener, rather than the other way around. + jakarta.faces.component + UIComponentBase + + + java.lang.Class + jakarta.faces.event.ComponentSystemEventListener + + + + + + JSF:JAVADOC:2757 + Override the default UIComponentBase#broadcast processing to unwrap any wrapped FacesEvent and reset the current row index, before the event is actually broadcast. For events that we did not wrap (in queueEvent()), default processing will occur. + jakarta.faces.component + UIData + + + jakarta.faces.event.FacesEvent + + + + + + JSF:JAVADOC:2758 + Signal the Jakarta Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UIData + + + jakarta.faces.event.FacesEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:2759 + Generate an identifier for a component. The identifier will be prefixed with UNIQUE_ID_PREFIX, and will be unique within this component-container. Optionally, a unique seed value can be supplied by component creators which should be included in the generated unique id. + jakarta.faces.component + UIData + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2760 + In addition to the default behavior, ensure that any saved per-row state for our child input components is discarded unless it is needed to rerender the current page with errors. + jakarta.faces.component + UIData + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2761 + if an input/output error occurs while rendering + jakarta.faces.component + UIData + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + JSF:JAVADOC:2762 + Return a client identifier for this component that includes the current value of the rowIndex property, if it is not set to -1. This implies that multiple calls to getClientId() may return different results, but ensures that child components can themselves generate row-specific client identifiers (since UIData is a NamingContainer). + jakarta.faces.component + UIData + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2763 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UIData + + + + + JSF:JAVADOC:2764 + Return the zero-relative row number of the first row to be displayed. + jakarta.faces.component + UIData + + + + + JSF:JAVADOC:2765 + Return the footer facet of this component (if any). A convenience method for getFacet("footer"). + jakarta.faces.component + UIData + + + + + JSF:JAVADOC:2766 + Return the header facet of this component (if any). A convenience method for getFacet("header"). + jakarta.faces.component + UIData + + + + + JSF:JAVADOC:2767 + Return the number of rows in the underlying data model. If the number of available rows is unknown, return -1. + jakarta.faces.component + UIData + + + + + JSF:JAVADOC:2768 + Return the data object representing the data for the currently selected row index, if any. + jakarta.faces.component + UIData + + + + + JSF:JAVADOC:2769 + Return the zero-relative index of the currently selected row. If we are not currently positioned on a row, return -1. This property is not enabled for value binding expressions. + jakarta.faces.component + UIData + + + + + JSF:JAVADOC:2770 + Return the number of rows to be displayed, or zero for all remaining rows in the table. The default value of this property is zero. + jakarta.faces.component + UIData + + + + + JSF:JAVADOC:2771 + Return the value of the UIData. This value must either be be of type DataModel, or a type that can be adapted into a DataModel. UIData will automatically adapt the following types: Arrays java.util.List java.sql.ResultSet java.util.Collection All other types will be adapted using the ScalarDataModel class, which will treat the object as a single row of data. + jakarta.faces.component + UIData + + + + + JSF:JAVADOC:2772 + Return the request-scope attribute under which the data object for the current row will be exposed when iterating. This property is not enabled for value binding expressions. + jakarta.faces.component + UIData + + + + + JSF:JAVADOC:2773 + Override behavior from UIComponentBase#invokeOnComponent to provide special care for positioning the data properly before finding the component and invoking the callback on it. If the argument clientId is equal to this.getClientId() simply invoke the contextCallback, passing the context argument and this as arguments, and return true. If the argument clientId is not equal to this.getClientId(), inspect each of the facet children of this UIData instance and for each one, compare its clientId with the argument clientId. If there is a match, invoke the contextCallback, passing the context argument and this as arguments, and return true. Otherwise, attempt to extract a rowIndex from the clientId. For example, if the argument clientId was form:data:3:customerHeader the rowIndex would be 3. Let this value be called newIndex. The current rowIndex of this instance must be saved aside and restored before returning in all cases, regardless of the outcome of the search or if any exceptions are thrown in the process. The implementation of this method must never return true if setting the rowIndex of this instance to be equal to newIndex causes this instance to return false from #isRowAvailable. + jakarta.faces.component + UIData + + + jakarta.faces.context.FacesContext + java.lang.String + jakarta.faces.component.ContextCallback + + + + + + JSF:JAVADOC:2774 + {@inheritDoc} Also throws FacesException if any exception is thrown when deriving the rowIndex from the argument clientId. + jakarta.faces.component + UIData + + + jakarta.faces.context.FacesContext + java.lang.String + jakarta.faces.component.ContextCallback + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:2775 + Return a flag indicating whether there is rowData available at the current rowIndex. If no wrappedData is available, return false. + jakarta.faces.component + UIData + + + + + JSF:JAVADOC:2776 + Return the value of the rowStatePreserved JavaBeans property. See #setRowStatePreserved. + jakarta.faces.component + UIData + + + + + JSF:JAVADOC:2777 + Override the base class method to take special action if the method is being invoked when StateManager#IS_BUILDING_INITIAL_STATE is true and the rowStatePreserved JavaBeans property for this instance is true. The additional action taken is to traverse the descendents and save their state without regard to any particular row value. + jakarta.faces.component + UIData + + + + + JSF:JAVADOC:2778 + Override the default UIComponentBase#processDecodes processing to perform the following steps. If the rendered property of this UIComponent is false, skip further processing. Set the current rowIndex to -1. Call the processDecodes() method of all facets of this UIData, in the order determined by a call to getFacets().keySet().iterator(). Call the processDecodes() method of all facets of the UIColumn children of this UIData. Iterate over the set of rows that were included when this component was rendered (i.e. those defined by the first and rows properties), performing the following processing for each row: Set the current rowIndex to the appropriate value for this row. If isRowAvailable() returns true, iterate over the children components of each UIColumn child of this UIData component, calling the processDecodes() method for each such child. Set the current rowIndex to -1. Call the decode() method of this component. If a RuntimeException is thrown during decode processing, call FacesContext#renderResponse and re-throw the exception. + jakarta.faces.component + UIData + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2779 + Override the default UIComponentBase#processUpdates processing to perform the following steps. If the rendered property of this UIComponent is false, skip further processing. Set the current rowIndex to -1. Call the processUpdates() method of all facets of this UIData, in the order determined by a call to getFacets().keySet().iterator(). Call the processUpdates() method of all facets of the UIColumn children of this UIData. Iterate over the set of rows that were included when this component was rendered (i.e. those defined by the first and rows properties), performing the following processing for each row: Set the current rowIndex to the appropriate value for this row. If isRowAvailable() returns true, iterate over the children components of each UIColumn child of this UIData component, calling the processUpdates() method for each such child. Set the current rowIndex to -1. + jakarta.faces.component + UIData + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2780 + Override the default UIComponentBase#processValidators processing to perform the following steps. If the rendered property of this UIComponent is false, skip further processing. Set the current rowIndex to -1. Call the processValidators() method of all facets of this UIData, in the order determined by a call to getFacets().keySet().iterator(). Call the processValidators() method of all facets of the UIColumn children of this UIData. Iterate over the set of rows that were included when this component was rendered (i.e. those defined by the first and rows properties), performing the following processing for each row: Set the current rowIndex to the appropriate value for this row. If isRowAvailable() returns true, iterate over the children components of each UIColumn child of this UIData component, calling the processValidators() method for each such child. Set the current rowIndex to -1. + jakarta.faces.component + UIData + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2781 + Override the default UIComponentBase#queueEvent processing to wrap any queued events in a wrapper so that we can reset the current row index in broadcast(). + jakarta.faces.component + UIData + + + jakarta.faces.event.FacesEvent + + + + + + JSF:JAVADOC:2782 + + jakarta.faces.component + UIData + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:2783 + + jakarta.faces.component + UIData + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2784 + Set the zero-relative row number of the first row to be displayed. + jakarta.faces.component + UIData + + + int + + + + + + JSF:JAVADOC:2785 + Set the footer facet of this component. A convenience method for getFacets().put("footer", footer). + jakarta.faces.component + UIData + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:2786 + Set the header facet of this component. A convenience method for getFacets().put("header", header). + jakarta.faces.component + UIData + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:2787 + Set the zero relative index of the current row, or -1 to indicate that no row is currently selected, by implementing the following algorithm. It is possible to set the row index at a value for which the underlying data collection does not contain any row data. Therefore, callers may use the isRowAvailable() method to detect whether row data will be available for use by the getRowData() method. To support transient state among descendents, please consult the specification for #setRowStatePreserved, which details the requirements for setRowIndex() when the rowStatePreserved JavaBeans property is set to true. Save current state information for all descendant components (as described below). Store the new row index, and pass it on to the DataModel associated with this UIData instance. If the new rowIndex value is -1: If the var property is not null, remove the corresponding request scope attribute (if any). Reset the state information for all descendant components (as described below). If the new rowIndex value is not -1: If the var property is not null, call getRowData() and expose the resulting data object as a request scope attribute whose key is the var property value. Reset the state information for all descendant components (as described below). To save current state information for all descendant components, UIData must maintain per-row information for each descendant as follows: If the descendant is an instance of EditableValueHolder, save the state of its localValue property. If the descendant is an instance of EditableValueHolder, save the state of the localValueSet property. If the descendant is an instance of EditableValueHolder, save the state of the valid property. If the descendant is an instance of EditableValueHolder, save the state of the submittedValue property. To restore current state information for all descendant components, UIData must reference its previously stored information for the current rowIndex and call setters for each descendant as follows: If the descendant is an instance of EditableValueHolder, restore the value property. If the descendant is an instance of EditableValueHolder, restore the state of the localValueSet property. If the descendant is an instance of EditableValueHolder, restore the state of the valid property. If the descendant is an instance of EditableValueHolder, restore the state of the submittedValue property. + jakarta.faces.component + UIData + + + int + + + + + + JSF:JAVADOC:2788 + Set the number of rows to be displayed, or zero for all remaining rows in the table. + jakarta.faces.component + UIData + + + int + + + + + + JSF:JAVADOC:2789 + If this property is set to true, the UIData must take steps to ensure that modifications to its iterated children will be preserved on a per-row basis. This allows applications to modify component properties, such as the style-class, for a specific row, rather than having such modifications apply to all rows. To accomplish this, UIData must call StateHolder#saveState and TransientStateHolder#saveTransientState on its children to capture their state on exiting each row. When re-entering the row, StateHolder#restoreState and TransientStateHolder#restoreTransientState must be called in order to reinitialize the children to the correct state for the new row. All of this action must take place during the processing of #setRowIndex. Users should consider enabling this feature for cases where it is necessary to modify properties of UIData's children in a row-specific way. Note, however, that row-level state saving/restoring does add overhead. As such, this feature should be used judiciously. + jakarta.faces.component + UIData + + + boolean + + + + + + JSF:JAVADOC:2790 + Set the value of the UIData. This value must either be be of type DataModel, or a type that can be adapted into a DataModel. + jakarta.faces.component + UIData + + + java.lang.Object + + + + + + JSF:JAVADOC:2791 + Set the ValueExpression used to calculate the value for the specified attribute or property name, if any. In addition, if a ValueExpression is set for the value property, remove any synthesized DataModel for the data previously bound to this component. + jakarta.faces.component + UIData + + + java.lang.String + jakarta.el.ValueExpression + + + + + + JSF:JAVADOC:2792 + Set the request-scope attribute under which the data object for the current row wil be exposed when iterating. + jakarta.faces.component + UIData + + + java.lang.String + + + + + + JSF:JAVADOC:2793 + Create a new UIData instance with default property values. + jakarta.faces.component + UIData + + + + + JSF:JAVADOC:2794 + Override the behavior in UIComponent#visitTree to handle iteration correctly. If the UIComponent#isVisitable method of this instance returns false, take no action and return. Call UIComponent#pushComponentToEL and invoke the visit callback on this UIData instance as described in UIComponent#visitTree. Let the result of the invoctaion be visitResult. If visitResult is VisitResult#COMPLETE, take no further action and return true. Otherwise, determine if we need to visit our children. The default implementation calls VisitContext#getSubtreeIdsToVisit passing this as the argument. If the result of that call is non-empty, let doVisitChildren be true. If doVisitChildren is true and visitResult is VisitResult#ACCEPT, take the following action. If this component has facets, call UIComponent#getFacets on this instance and invoke the values() method. For each UIComponent in the returned Map, call UIComponent#visitTree. If this component has children, for each UIColumn child: Call VisitContext#invokeVisitCallback on that UIColumn instance. If such a call returns true, terminate visiting and return true from this method. If the child UIColumn has facets, call UIComponent#visitTree on each one. Take no action on non-UIColumn children. Save aside the result of a call to #getRowIndex. For each child component of this UIData that is also an instance of UIColumn, Iterate over the rows. Let rowsToProcess be the return from #getRows. Let rowIndex be the return from #getFirst - 1. While the number of rows processed is less than rowsToProcess, take the following actions. Call #setRowIndex, passing the current row index. If #isRowAvailable returns false, take no further action and return false. Call UIComponent#visitTree on each of the children of this UIColumn instance. Call #popComponentFromEL and restore the saved row index with a call to #setRowIndex. Return false to allow the visiting to continue. + jakarta.faces.component + UIData + + + jakarta.faces.component.visit.VisitContext + jakarta.faces.component.visit.VisitCallback + + + + + + JSF:JAVADOC:2795 + Generate an identifier for a component. The identifier will be prefixed with UNIQUE_ID_PREFIX, and will be unique within this component-container. Optionally, a unique seed value can be supplied by component creators which should be included in the generated unique id. If the prependId property has the value false, this method must call createUniqueId on the next ancestor UniqueIdVendor. + jakarta.faces.component + UIForm + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2796 + Override the UIComponent#getContainerClientId to allow users to disable this form from prepending its clientId to its descendent's clientIds depending on the value of this form's #isPrependId property. + jakarta.faces.component + UIForm + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2797 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UIForm + + + + + JSF:JAVADOC:2798 + Is the id prepended. + jakarta.faces.component + UIForm + + + + + JSF:JAVADOC:2799 + Returns the current value of the submitted property. The default value is false. See #setSubmitted for details. This property must be kept as a transient property using the UIComponent#getTransientStateHelper. + jakarta.faces.component + UIForm + + + + + JSF:JAVADOC:2800 + Override UIComponent#processDecodes to ensure that the form is decoded before its children. This is necessary to allow the submitted property to be correctly set. + jakarta.faces.component + UIForm + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2801 + Override UIComponent#processUpdates to ensure that the children of this UIForm instance are only processed if #isSubmitted returns true. + jakarta.faces.component + UIForm + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2802 + Override UIComponent#processValidators to ensure that the children of this UIForm instance are only processed if #isSubmitted returns true. + jakarta.faces.component + UIForm + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2803 + Set whether the id should be prepended. + jakarta.faces.component + UIForm + + + boolean + + + + + + JSF:JAVADOC:2804 + If this UIForm instance (as opposed to other forms in the page) is experiencing a submit during this request processing lifecycle, this method must be called, with true as the argument, during the UIComponent#decode for this UIForm instance. If this UIForm instance is not experiencing a submit, this method must be called, with false as the argument, during the UIComponent#decode for this UIForm instance. The value of a UIForm's submitted property must not be saved as part of its state. This property must be kept as a transient property using the UIComponent#getTransientStateHelper. + jakarta.faces.component + UIForm + + + boolean + + + + + + JSF:JAVADOC:2805 + Perform a tree visit starting at this node in the tree. UIComponent.visitTree() implementations do not invoke the VisitCallback directly, but instead call VisitContext#invokeVisitCallback to invoke the callback. This allows VisitContext implementations to provide optimized tree traversals, for example by only calling the VisitCallback for a subset of components. UIComponent.visitTree() implementations must call UIComponent.pushComponentToEL() before performing the visit and UIComponent.popComponentFromEL() after the visit. + jakarta.faces.component + UIForm + + + jakarta.faces.component.visit.VisitContext + jakarta.faces.component.visit.VisitCallback + + + + + + JSF:JAVADOC:2806 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UIGraphic + + + + + JSF:JAVADOC:2807 + Return the image URL for this UIGraphic. This method is a typesafe alias for getValue(). + jakarta.faces.component + UIGraphic + + + + + JSF:JAVADOC:2808 + Returns the value property of the UIGraphic. This will typically be rendered as an URL. + jakarta.faces.component + UIGraphic + + + + + JSF:JAVADOC:2809 + Return any ValueExpression set for value if a ValueExpression for url is requested; otherwise, perform the default superclass processing for this method. + jakarta.faces.component + UIGraphic + + + java.lang.String + + + + + + JSF:JAVADOC:2810 + Set the image URL for this UIGraphic. This method is a typesafe alias for setValue(). + jakarta.faces.component + UIGraphic + + + java.lang.String + + + + + + JSF:JAVADOC:2811 + Sets the value property of the UIGraphic. This will typically be rendered as an URL. + jakarta.faces.component + UIGraphic + + + java.lang.Object + + + + + + JSF:JAVADOC:2812 + Store any ValueExpression specified for url under value instead; otherwise, perform the default superclass processing for this method. + jakarta.faces.component + UIGraphic + + + java.lang.String + jakarta.el.ValueExpression + + + + + + JSF:JAVADOC:2813 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UIImportConstants + + + + + JSF:JAVADOC:2814 + Returns the fully qualified name of the type to import the constant field values for. + jakarta.faces.component + UIImportConstants + + + + + JSF:JAVADOC:2815 + Returns name of request scope attribute under which constants will be exposed as a Map. + jakarta.faces.component + UIImportConstants + + + + + JSF:JAVADOC:2816 + Sets the fully qualified name of the type to import the constant field values for. + jakarta.faces.component + UIImportConstants + + + java.lang.String + + + + + + JSF:JAVADOC:2817 + Set the ValueExpression used to calculate the value for the specified attribute or property name, if any. If a ValueExpression is set for the var property, throw an illegal argument exception. + jakarta.faces.component + UIImportConstants + + + java.lang.String + jakarta.el.ValueExpression + + + + + + JSF:JAVADOC:2818 + Sets name of request scope attribute under which constants will be exposed as a Map. + jakarta.faces.component + UIImportConstants + + + java.lang.String + + + + + + JSF:JAVADOC:2819 + Create a new UIImportConstants instance with renderer type set to null. + jakarta.faces.component + UIImportConstants + + + + + JSF:JAVADOC:2820 + Add a Validator instance to the set associated with this UIInput. + jakarta.faces.component + UIInput + + + jakarta.faces.validator.Validator + + + + + + JSF:JAVADOC:2821 + Add a new ValueChangeListener to the set of listeners interested in being notified when ValueChangeEvents occur. + jakarta.faces.component + UIInput + + + jakarta.faces.event.ValueChangeListener + + + + + + JSF:JAVADOC:2822 + For each of the attached objects on this instance that implement PartialStateHolder, call PartialStateHolder#clearInitialState on the attached object. + jakarta.faces.component + UIInput + + + + + JSF:JAVADOC:2823 + Decode any new state of this UIComponent from the request contained in the specified FacesContext, and store this state as needed. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling queueEvent(). + jakarta.faces.component + UIInput + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2824 + If there has been a call to #setConverterMessage on this instance, return the message. Otherwise, call #getValueExpression passing the key "converterMessage", get the result of the expression, and return it. Any ELExceptions thrown during the call to getValue() must be wrapped in a FacesException and rethrown. + jakarta.faces.component + UIInput + + + + + JSF:JAVADOC:2825 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UIInput + + + + + JSF:JAVADOC:2826 + If there has been a call to #setRequiredMessage on this instance, return the message. Otherwise, call #getValueExpression passing the key "requiredMessage", get the result of the expression, and return it. Any ELExceptions thrown during the call to getValue() must be wrapped in a FacesException and rethrown. + jakarta.faces.component + UIInput + + + + + JSF:JAVADOC:2827 + Return the submittedValue value of this UIInput component. This method should only be used by the decode() and validate() method of this component, or its corresponding Renderer. + jakarta.faces.component + UIInput + + + + + JSF:JAVADOC:2828 + If there has been a call to #setValidatorMessage on this instance, return the message. Otherwise, call #getValueExpression passing the key "validatorMessage", get the result of the expression, and return it. Any ELExceptions thrown during the call to getValue() must be wrapped in a FacesException and rethrown. + jakarta.faces.component + UIInput + + + + + JSF:JAVADOC:2829 + Return the set of registered Validators for this UIInput instance. If there are no registered validators, a zero-length array is returned. + jakarta.faces.component + UIInput + + + + + JSF:JAVADOC:2830 + If there is a local value, return it, otherwise return the result of calling super.getVaue(). + jakarta.faces.component + UIInput + + + + + JSF:JAVADOC:2831 + Return the set of registered ValueChangeListeners for this UIInput instance. If there are no registered listeners, a zero-length array is returned. + jakarta.faces.component + UIInput + + + + + JSF:JAVADOC:2832 + Is the value denoting an empty value. If the value is null, return true. If the value is a String and it is the empty string, return true. If the value is an array and the array length is 0, return true. If the value is a List and the List is empty, return true. If the value is a Collection and the Collection is empty, return true. If the value is a Map and the Map is empty, return true. In all other cases, return false. + jakarta.faces.component + UIInput + + + java.lang.Object + + + + + + JSF:JAVADOC:2833 + Return the "immediate" state for this component. + jakarta.faces.component + UIInput + + + + + JSF:JAVADOC:2834 + Return the "local value set" state for this component. Calls to setValue() automatically reset this property to true. + jakarta.faces.component + UIInput + + + + + JSF:JAVADOC:2835 + Return the "required field" state for this component. + jakarta.faces.component + UIInput + + + + + JSF:JAVADOC:2836 + Return a flag indicating whether the local value of this component is valid (no conversion error has occurred). + jakarta.faces.component + UIInput + + + + + JSF:JAVADOC:2837 + In addition to the actions taken in UIOutput when PartialStateHolder#markInitialState() is called, check if any of the installed Validators are PartialStateHolders and if so, call jakarta.faces.component.PartialStateHolder#markInitialState() as appropriate. + jakarta.faces.component + UIInput + + + + + JSF:JAVADOC:2838 + Specialized decode behavior on top of that provided by the superclass. In addition to the standard processDecodes behavior inherited from UIComponentBase, calls validate() if the the immediate property is true; if the component is invalid afterwards or a RuntimeException is thrown, calls FacesContext#renderResponse. + jakarta.faces.component + UIInput + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2839 + In addition to the standard processUpdates behavior inherited from UIComponentBase, calls updateModel(). If the component is invalid afterwards, calls FacesContext#renderResponse. If a RuntimeException is thrown during update processing, calls FacesContext#renderResponse and re-throw the exception. + jakarta.faces.component + UIInput + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2840 + In addition to the standard processValidators behavior inherited from UIComponentBase, calls validate() if the immediate property is false (which is the default); if the component is invalid afterwards, calls FacesContext#renderResponse. To ensure the PostValidateEvent is published at the proper time, this component must be validated first, followed by the component's children and facets. If a RuntimeException is thrown during validation processing, calls FacesContext#renderResponse and re-throw the exception. + jakarta.faces.component + UIInput + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2841 + Remove a Validator instance from the set associated with this UIInput, if it was previously associated. Otherwise, do nothing. + jakarta.faces.component + UIInput + + + jakarta.faces.validator.Validator + + + + + + JSF:JAVADOC:2842 + Remove an existing ValueChangeListener (if any) from the set of listeners interested in being notified when ValueChangeEvents occur. + jakarta.faces.component + UIInput + + + jakarta.faces.event.ValueChangeListener + + + + + + JSF:JAVADOC:2843 + Convenience method to reset this component's value to the un-initialized state. This method does the following: Call UIOutput#setValue. Call #setSubmittedValue passing null. Clear state for property localValueSet. Clear state for property valid. Upon return from this call if the instance had a ValueBinding associated with it for the "value" property, this binding is evaluated when UIOutput#getValue is called. Otherwise, null is returned from getValue(). + jakarta.faces.component + UIInput + + + + + JSF:JAVADOC:2844 + + jakarta.faces.component + UIInput + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:2845 + + jakarta.faces.component + UIInput + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2846 + Override any ValueExpression set for the "converterMessage" with the literal argument provided to this method. Subsequent calls to #getConverterMessage will return this value; + jakarta.faces.component + UIInput + + + java.lang.String + + + + + + JSF:JAVADOC:2847 + Set the "immediate" state for this component. When set to true, the component's value will be converted and validated immediately in the Apply Request Values phase, and ValueChangeEvents will be delivered in that phase as well. The default value for this property must be false. + jakarta.faces.component + UIInput + + + boolean + + + + + + JSF:JAVADOC:2848 + Sets the "local value set" state for this component. + jakarta.faces.component + UIInput + + + boolean + + + + + + JSF:JAVADOC:2849 + Set the "required field" state for this component. + jakarta.faces.component + UIInput + + + boolean + + + + + + JSF:JAVADOC:2850 + Override any ValueExpression set for the "requiredMessage" with the literal argument provided to this method. Subsequent calls to #getRequiredMessage will return this value; + jakarta.faces.component + UIInput + + + java.lang.String + + + + + + JSF:JAVADOC:2851 + Set the submittedValue value of this UIInput component. This method should only be used by the decode() and validate() method of this component, or its corresponding Renderer. + jakarta.faces.component + UIInput + + + java.lang.Object + + + + + + JSF:JAVADOC:2852 + Set a flag indicating whether the local value of this component is valid (no conversion error has occurred). + jakarta.faces.component + UIInput + + + boolean + + + + + + JSF:JAVADOC:2853 + Override any ValueExpression set for the "validatorMessage" with the literal argument provided to this method. Subsequent calls to #getValidatorMessage will return this value; + jakarta.faces.component + UIInput + + + java.lang.String + + + + + + JSF:JAVADOC:2854 + Set the value of this UIComponent (if any). + jakarta.faces.component + UIInput + + + java.lang.Object + + + + + + JSF:JAVADOC:2855 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UIMessage + + + + + JSF:JAVADOC:2856 + Return the Identifier of the component for which to render error messages. If this component is within the same NamingContainer as the target component, this must be the component identifier. Otherwise, it must be an absolute component identifier (starting with ":"). See the UIComponent#findComponent for more information. + jakarta.faces.component + UIMessage + + + + + JSF:JAVADOC:2857 + + jakarta.faces.component + UIMessage + + + + + JSF:JAVADOC:2858 + Return the flag indicating whether the detail property of the associated message(s) should be displayed. Defaults to true. + jakarta.faces.component + UIMessage + + + + + JSF:JAVADOC:2859 + Return the flag indicating whether the summary property of the associated message(s) should be displayed. Defaults to false. + jakarta.faces.component + UIMessage + + + + + JSF:JAVADOC:2860 + Set the identifier of the component for which this component represents associated message(s) (if any). This property must be set before the message is displayed. + jakarta.faces.component + UIMessage + + + java.lang.String + + + + + + JSF:JAVADOC:2861 + Set the flag indicating whether the detail property of the associated message(s) should be displayed. + jakarta.faces.component + UIMessage + + + boolean + + + + + + JSF:JAVADOC:2862 + Set the flag indicating whether the detail property of the associated message(s) should be displayed. + jakarta.faces.component + UIMessage + + + boolean + + + + + + JSF:JAVADOC:2863 + Set the flag indicating whether the summary property of the associated message(s) should be displayed. + jakarta.faces.component + UIMessage + + + boolean + + + + + + JSF:JAVADOC:2864 + Create a new UIMessage instance with default property values. + jakarta.faces.component + UIMessage + + + + + JSF:JAVADOC:2865 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UIMessages + + + + + JSF:JAVADOC:2866 + Return the client identifier of the component for which this component represents associated message(s) (if any). + jakarta.faces.component + UIMessages + + + + + JSF:JAVADOC:2867 + Return the flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered. Mutually exclusive with the "for" property which takes precedence. Defaults to false. + jakarta.faces.component + UIMessages + + + + + JSF:JAVADOC:2868 + + jakarta.faces.component + UIMessages + + + + + JSF:JAVADOC:2869 + Return the flag indicating whether the detail property of the associated message(s) should be displayed. Defaults to false. + jakarta.faces.component + UIMessages + + + + + JSF:JAVADOC:2870 + Return the flag indicating whether the summary property of the associated message(s) should be displayed. Defaults to true. + jakarta.faces.component + UIMessages + + + + + JSF:JAVADOC:2871 + Set the client identifier of the component for which this component represents associated message(s) (if any). This property must be set before the message is displayed. + jakarta.faces.component + UIMessages + + + java.lang.String + + + + + + JSF:JAVADOC:2872 + Set the flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered. + jakarta.faces.component + UIMessages + + + boolean + + + + + + JSF:JAVADOC:2873 + Set the flag indicating whether the detail property of the associated message(s) should be displayed. + jakarta.faces.component + UIMessages + + + boolean + + + + + + JSF:JAVADOC:2874 + Set the flag indicating whether the detail property of the associated message(s) should be displayed. + jakarta.faces.component + UIMessages + + + boolean + + + + + + JSF:JAVADOC:2875 + Set the flag indicating whether the summary property of the associated message(s) should be displayed. + jakarta.faces.component + UIMessages + + + boolean + + + + + + JSF:JAVADOC:2876 + Create a new UIMessages instance with default property values. + jakarta.faces.component + UIMessages + + + + + JSF:JAVADOC:2877 + Generate an identifier for a component. The identifier will be prefixed with UNIQUE_ID_PREFIX, and will be unique within this component-container. Optionally, a unique seed value can be supplied by component creators which should be included in the generated unique id. + jakarta.faces.component + UINamingContainer + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2878 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UINamingContainer + + + + + JSF:JAVADOC:2879 + Return the character used to separate segments of a clientId. The implementation must determine if there is a with the value given by the value of the symbolic constant #SEPARATOR_CHAR_PARAM_NAME. If there is a value for this param, the first character of the value must be returned from this method. Otherwise, the value of the symbolic constant NamingContainer#SEPARATOR_CHAR must be returned. + jakarta.faces.component + UINamingContainer + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2880 + Perform a tree visit starting at this node in the tree. UIComponent.visitTree() implementations do not invoke the VisitCallback directly, but instead call VisitContext#invokeVisitCallback to invoke the callback. This allows VisitContext implementations to provide optimized tree traversals, for example by only calling the VisitCallback for a subset of components. UIComponent.visitTree() implementations must call UIComponent.pushComponentToEL() before performing the visit and UIComponent.popComponentFromEL() after the visit. + jakarta.faces.component + UINamingContainer + + + jakarta.faces.component.visit.VisitContext + jakarta.faces.component.visit.VisitCallback + + + + + + JSF:JAVADOC:2881 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UIOutcomeTarget + + + + + JSF:JAVADOC:2882 + Returns the outcome property of the UIOutcomeTarget. This value is passed to the jakarta.faces.application.NavigationHandler when resolving the target url of this component. + jakarta.faces.component + UIOutcomeTarget + + + + + JSF:JAVADOC:2883 + Return whether or not the client window should be encoded into the target url. + jakarta.faces.component + UIOutcomeTarget + + + + + JSF:JAVADOC:2884 + Return whether or not the view parameters should be encoded into the target url. + jakarta.faces.component + UIOutcomeTarget + + + + + JSF:JAVADOC:2885 + Set whether or not the client window should be encoded into the target url. + jakarta.faces.component + UIOutcomeTarget + + + boolean + + + + + + JSF:JAVADOC:2886 + Set whether or not the page parameters should be encoded into the target url. + jakarta.faces.component + UIOutcomeTarget + + + boolean + + + + + + JSF:JAVADOC:2887 + Sets the outcome property of the UIOutcomeTarget. This value is passed to the NavigationHandler when resolving the target url of this component. + jakarta.faces.component + UIOutcomeTarget + + + java.lang.String + + + + + + JSF:JAVADOC:2888 + Create a new UIOutcomeTarget instance with default property values. + jakarta.faces.component + UIOutcomeTarget + + + + + JSF:JAVADOC:2889 + For each of the attached objects on this instance that implement PartialStateHolder, call PartialStateHolder#clearInitialState on the attached object. + jakarta.faces.component + UIOutput + + + + + JSF:JAVADOC:2890 + Return the Converter (if any) that is registered for this UIComponent. + jakarta.faces.component + UIOutput + + + + + JSF:JAVADOC:2891 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UIOutput + + + + + JSF:JAVADOC:2892 + Return the local value of this UIComponent (if any), without evaluating any associated ValueExpression. + jakarta.faces.component + UIOutput + + + + + JSF:JAVADOC:2893 + In addition to the actions taken in UIComponentBase when PartialStateHolder#markInitialState() is called, check if the installed Converter is a PartialStateHolder and if it is, call jakarta.faces.component.PartialStateHolder#markInitialState() on it. + jakarta.faces.component + UIOutput + + + + + JSF:JAVADOC:2894 + Convenience method to reset this component's value to the un-initialized state. + jakarta.faces.component + UIOutput + + + + + JSF:JAVADOC:2895 + + jakarta.faces.component + UIOutput + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:2896 + + jakarta.faces.component + UIOutput + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2897 + Set the Converter (if any) that is registered for this UIComponent. + jakarta.faces.component + UIOutput + + + jakarta.faces.convert.Converter + + + + + + JSF:JAVADOC:2898 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UIPanel + + + + + JSF:JAVADOC:2899 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UIParameter + + + + + JSF:JAVADOC:2900 + Returns the value property of the UIParameter. + jakarta.faces.component + UIParameter + + + + + JSF:JAVADOC:2901 + Return the value of the disable directive for this component. This directive determines whether the parameter value should be disabled by assigning it a null value. If true, the value set on this component is ignored. + jakarta.faces.component + UIParameter + + + + + JSF:JAVADOC:2902 + Sets the disable property of the UIParameter. + jakarta.faces.component + UIParameter + + + boolean + + + + + + JSF:JAVADOC:2903 + Sets the value property of the\ UIParameter. + jakarta.faces.component + UIParameter + + + java.lang.Object + + + + + + JSF:JAVADOC:2904 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UISelectBoolean + + + + + JSF:JAVADOC:2905 + Return any ValueExpression set for value if a ValueExpression for selected is requested; otherwise, perform the default superclass processing for this method. + jakarta.faces.component + UISelectBoolean + + + java.lang.String + + + + + + JSF:JAVADOC:2906 + Store any ValueExpression specified for selected under value instead; otherwise, perform the default superclass processing for this method. + jakarta.faces.component + UISelectBoolean + + + java.lang.String + jakarta.el.ValueExpression + + + + + + JSF:JAVADOC:2907 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UISelectItem + + + + + JSF:JAVADOC:2908 + Return the server value for this selection item. + jakarta.faces.component + UISelectItem + + + + + JSF:JAVADOC:2909 + Returns the value property of the UISelectItem. + jakarta.faces.component + UISelectItem + + + + + JSF:JAVADOC:2910 + Return the disabled setting for this selection item. + jakarta.faces.component + UISelectItem + + + + + JSF:JAVADOC:2911 + Return the escape setting for the label of this selection item. + jakarta.faces.component + UISelectItem + + + + + JSF:JAVADOC:2912 + Return the value of the noSelectionOption property. If the value of this property is true, the system interprets the option represented by this UISelectItem instance as representing a "no selection" option. See UISelectOne#validateValue and UISelectMany#validateValue for usage. + jakarta.faces.component + UISelectItem + + + + + JSF:JAVADOC:2913 + Set the disabled value for this selection item. + jakarta.faces.component + UISelectItem + + + boolean + + + + + + JSF:JAVADOC:2914 + Set the escape value for the label of this selection item. + jakarta.faces.component + UISelectItem + + + boolean + + + + + + JSF:JAVADOC:2915 + Set the server value for this selection item. + jakarta.faces.component + UISelectItem + + + java.lang.Object + + + + + + JSF:JAVADOC:2916 + Set the value of the noSelectionOption property. + jakarta.faces.component + UISelectItem + + + boolean + + + + + + JSF:JAVADOC:2917 + Sets the value property of the UISelectItem. + jakarta.faces.component + UISelectItem + + + java.lang.Object + + + + + + JSF:JAVADOC:2918 + Return a new SelectItemGroup instance containing one or more SelectItem instances represented by any nested UISelectItems or UISelectItem components. + jakarta.faces.component + UISelectItemGroup + + + + + JSF:JAVADOC:2919 + + jakarta.faces.component + UISelectItemGroup + + + + + JSF:JAVADOC:2920 + Iterate over the value attribute and wrap each item in a new SelectItemGroup instance whereby the item is exposed as a request attribute under the key specified by the var property. This must allow any nested UISelectItems or UISelectItem component to access the item via their attributes. Finally return these SelectItemGroup instances as an ordered collection. + jakarta.faces.component + UISelectItemGroups + + + + + JSF:JAVADOC:2921 + + jakarta.faces.component + UISelectItemGroups + + + + + JSF:JAVADOC:2922 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UISelectItems + + + + + JSF:JAVADOC:2923 + Returns the value property of the UISelectItems. + jakarta.faces.component + UISelectItems + + + + + JSF:JAVADOC:2924 + Sets the value property of the UISelectItems. + jakarta.faces.component + UISelectItems + + + java.lang.Object + + + + + + JSF:JAVADOC:2925 + Set the ValueExpression used to calculate the value for the specified attribute or property name, if any. In addition, if a ValueExpression is set for the var property, regardless of the value, throw an illegal argument exception. + jakarta.faces.component + UISelectItems + + + java.lang.String + jakarta.el.ValueExpression + + + + + + JSF:JAVADOC:2926 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UISelectMany + + + + + JSF:JAVADOC:2927 + Return any ValueExpression set for value if a ValueExpression for selectedValues is requested; otherwise, perform the default superclass processing for this method. + jakarta.faces.component + UISelectMany + + + java.lang.String + + + + + + JSF:JAVADOC:2928 + Store any ValueExpression specified for selectedValues under value instead; otherwise, perform the default superclass processing for this method. + jakarta.faces.component + UISelectMany + + + java.lang.String + jakarta.el.ValueExpression + + + + + + JSF:JAVADOC:2929 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UISelectOne + + + + + JSF:JAVADOC:2930 + Returns the name of the radio button group. Radio button components having the same group within a UIForm parent will uncheck all others when being checked. If the value attribute is absent then the one from first component of the group will be used. If the UISelectItem child is absent then the one from first component of the group will be used. + jakarta.faces.component + UISelectOne + + + + + JSF:JAVADOC:2931 + If #getGroup() is set, and #getSubmittedValue() is empty, and at least one other component having the same group within a UIForm parent has a non-empty #getSubmittedValue() or returns true on #isLocalValueSet() or returns false on #isValid(), then skip validation for current component, else perform standard superclass processing by super.processValidators(context). + jakarta.faces.component + UISelectOne + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2932 + Sets the name of the radio button group. + jakarta.faces.component + UISelectOne + + + java.lang.String + + + + + + JSF:JAVADOC:2933 + + jakarta.faces.component + UIViewAction + + + jakarta.faces.event.ActionListener + + + + + + JSF:JAVADOC:2934 + Enable the method invocation specified by this component instance to return a value that performs navigation, similar in spirit to UICommand#broadcast. Take no action and return immediately if any of the following conditions are true. The response has already been marked as complete. The current UIViewRoot is different from the event's source's UIViewRoot. Save a local reference to the viewId of the current UIViewRoot. For discussion, let this reference be viewIdBeforeAction. Obtain the ActionListener from the jakarta.faces.application.Application. Wrap the current FacesContext in an implementation of jakarta.faces.context.FacesContextWrapper that overrides the FacesContext#renderResponse method such that it takes no action. Set the current FacesContext to be the FacesContextWrapper instance. Make it so a call to #isProcessingBroadcast on the current FacesContext will return true. This is necessary because the jakarta.faces.application.NavigationHandler will call this method to determine if the navigation is happening as the result of a UIViewAction. Invoke ActionListener#processAction. In a finally block, restore the original FacesContext, make it so a call to #isProcessingBroadcast on the current context will return false and discard the wrapper. If the response has been marked as complete during the invocation of processAction(), take no further action and return. Otherwise, compare viewIdBeforeAction with the viewId of the UIViewRoot on the FacesContext after the invocation of processAction(). If the two viewIds are the same and no more UIViewAction events have been queued by a call to #decode, call FacesContext#renderResponse and return. It is possible to detect the case where no more UIViewAction events have been queued because the number of such events queued has been noted in the specification for #decode. Otherwise, execute the lifecycle on the new UIViewRoot. + jakarta.faces.component + UIViewAction + + + jakarta.faces.event.FacesEvent + + + + + + JSF:JAVADOC:2935 + Signal the Jakarta Faces implementation that no further processing on the current event should be performed + jakarta.faces.component + UIViewAction + + + jakarta.faces.event.FacesEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:2936 + Override behavior from the superclass to queue an ActionEvent that may result in the invocation of the action or any actionListeners that may be associated with this instance. Take no action if any of the following conditions are true: The current request is a postback and the instance has been configured to not operate on postback. See #isOnPostback. The condition stated in the if property evaluates to false. See #isRendered . Instantiate an ActionEvent, passing this component instance as the source. Set the phaseId property of the ActionEvent as follows. If this component instance has been configured with a specific lifecycle phase with a call to #setPhase use that as the phaseId If the value of the immediate property is true, use PhaseId#APPLY_REQUEST_VALUES. Otherwise, use PhaseId#INVOKE_APPLICATION. Queue the event with a call to #queueEvent. Keep track of the number of events that are queued in this way on this run through the lifecycle. This information is necessary during processing in #broadcast. + jakarta.faces.component + UIViewAction + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2937 + + jakarta.faces.component + UIViewAction + + + + + JSF:JAVADOC:2938 + + jakarta.faces.component + UIViewAction + + + + + JSF:JAVADOC:2939 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UIViewAction + + + + + JSF:JAVADOC:2940 + Returns the name of the lifecycle phase in which the action is to be queued. + jakarta.faces.component + UIViewAction + + + + + JSF:JAVADOC:2941 + If the value of the component's immediate attribute is true, the action will be invoked during the Apply Request Values Jakarta Faces lifecycle phase. Otherwise, the action will be invoked during the Invoke Application phase, the default behavior. The phase can be set explicitly in the phase attribute, which takes precedence over the immediate attribute. + jakarta.faces.component + UIViewAction + + + + + JSF:JAVADOC:2942 + If true this component will operate on postback. + jakarta.faces.component + UIViewAction + + + + + JSF:JAVADOC:2943 + Returns true if the current request processing lifecycle is in the midst of processing the broadcast of an event queued during a call to #decode. The implementation of #broadcast is responsible for ensuring that calls to this method accurately reflect this fact. + jakarta.faces.component + UIViewAction + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2944 + Return true if this component should take the actions specified in the #decode method. + jakarta.faces.component + UIViewAction + + + + + JSF:JAVADOC:2945 + + jakarta.faces.component + UIViewAction + + + jakarta.faces.event.ActionListener + + + + + + JSF:JAVADOC:2946 + + jakarta.faces.component + UIViewAction + + + jakarta.el.MethodExpression + + + + + + JSF:JAVADOC:2947 + + jakarta.faces.component + UIViewAction + + + boolean + + + + + + JSF:JAVADOC:2948 + Controls whether or not this component operates on postback. + jakarta.faces.component + UIViewAction + + + boolean + + + + + + JSF:JAVADOC:2949 + Attempt to set the lifecycle phase in which this instance will queue its ActionEvent. Pass the argument phase to PhaseId#phaseIdValueOf. If the result is not one of the following values, FacesException must be thrown. PhaseId#APPLY_REQUEST_VALUESPhaseId#PROCESS_VALIDATIONSPhaseId#UPDATE_MODEL_VALUESPhaseId#INVOKE_APPLICATION If set, this value takes precedence over the immediate flag. + jakarta.faces.component + UIViewAction + + + java.lang.String + + + + + + JSF:JAVADOC:2950 + Sets the if property of this component. + jakarta.faces.component + UIViewAction + + + boolean + + + + + + JSF:JAVADOC:2951 + Create a new UIViewAction instance with default property values. + jakarta.faces.component + UIViewAction + + + + + JSF:JAVADOC:2952 + Override behavior from superclass to pull a value from the incoming request parameter map under the name given by #getName and store it with a call to UIInput#setSubmittedValue. + jakarta.faces.component + UIViewParameter + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2953 + Called specially by UIViewRoot#encodeEnd, this method simply sets the submitted value to be the return from #getStringValue. + jakarta.faces.component + UIViewParameter + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2954 + when an I/O error occurs. + jakarta.faces.component + UIViewParameter + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + JSF:JAVADOC:2955 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UIViewParameter + + + + + JSF:JAVADOC:2956 + Return the request parameter name from which the value is retrieved. + jakarta.faces.component + UIViewParameter + + + + + JSF:JAVADOC:2957 + If the value of this parameter comes from a ValueExpression return the value of the expression, otherwise, return the local value. + jakarta.faces.component + UIViewParameter + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2958 + Manually perform standard conversion steps to get a string value from the value expression. + jakarta.faces.component + UIViewParameter + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2959 + + jakarta.faces.component + UIViewParameter + + + jakarta.faces.context.FacesContext + + jakarta.faces.convert.ConverterException + + + + + JSF:JAVADOC:2960 + Assume that the submitted value is always a string, but the return type from this method is Object.. + jakarta.faces.component + UIViewParameter + + + + + JSF:JAVADOC:2961 + Return false. The immediate setting is not relevant for view parameters and must be assumed to be false. + jakarta.faces.component + UIViewParameter + + + + + JSF:JAVADOC:2962 + Specialize superclass behavior to treat null differently. In this class, a null value along with the "required" flag being set to true will cause a validation failure. Otherwise, If the UIInput#EMPTY_STRING_AS_NULL_PARAM_NAME context parameter is true and the value is null, call UIInput#setSubmittedValue passing the empty string as the argument. This will cause the normal validation processing to happen, including bean validation. + jakarta.faces.component + UIViewParameter + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2963 + Set the request parameter name from which the value is retrieved. + jakarta.faces.component + UIViewParameter + + + java.lang.String + + + + + + JSF:JAVADOC:2964 + PENDING (docs) Interesting that submitted value isn't saved by the parent + jakarta.faces.component + UIViewParameter + + + java.lang.Object + + + + + + JSF:JAVADOC:2965 + Create a new UIViewParameter instance with default property values. + jakarta.faces.component + UIViewParameter + + + + + JSF:JAVADOC:2966 + Call through to superclass UIInput#updateModel then take the additional action of pushing the value into request scope if and only if the value is not a value expression, is valid, and the local value was set on this lifecycle execution. + jakarta.faces.component + UIViewParameter + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2967 + Return the UIViewParameter to which this instance refers. If the current viewId is the same as the viewId passed to our constructor, use the index passed to the constructor to find the actual UIViewParameter instance and return it. Otherwise, call StateHolder#restoreState on the saved state and return the result. + jakarta.faces.component + UIViewParameter.Reference + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2968 + Construct a reference to a UIViewParameter. This constructor cause the StateHolder#saveState method to be called on argument UIViewParameter. + jakarta.faces.component + UIViewParameter.Reference + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewParameter + int + java.lang.String + + + + + + JSF:JAVADOC:2969 + Add argument component, which is assumed to represent a resource instance, as a resource to this view. A resource instance is rendered by a resource Renderer, as described in the Standard HTML RenderKit. The default implementation must call through to #addComponentResource(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.String). + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:2970 + Add argument component, which is assumed to represent a resource instance, as a resource to this view. A resource instance is rendered by a resource Renderer, as described in the Standard HTML RenderKit. The component must be added using the following algorithm: If the target argument is null, look for a target attribute on the component. If there is no target attribute, set target to be the default value head Call #getComponentResources to obtain the child list for the given target. If the component ID of componentResource matches the the ID of a resource that has allready been added, remove the old resource. Add the component resource to the list. The resource Renderer must ensure of the following: Do not render when ResourceHandler#isResourceRendered(FacesContext, String, String) returns true. After rendering, call ResourceHandler#markResourceRendered(FacesContext, String, String). + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:2971 + Add the argument newPhaseListener to the list of PhaseListeners on this UIViewRoot. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.event.PhaseListener + + + + + + JSF:JAVADOC:2972 + Broadcast any events that have been queued. First broadcast events that have been queued for PhaseId#ANY_PHASE. Then broadcast ane events that have been queued for the current phase. In both cases, UIComponent#pushComponentToEL must be called before the event is broadcast, and UIComponent#popComponentFromEL must be called after the return from the broadcast, even in the case of an exception. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + jakarta.faces.event.PhaseId + + + + + + JSF:JAVADOC:2973 + Generate an identifier for a component. The identifier will be prefixed with UNIQUE_ID_PREFIX, and will be unique within the non-NamingContainer child sub-trees of this UIViewRoot. + jakarta.faces.component + UIViewRoot + + + + + JSF:JAVADOC:2974 + Generate an identifier for a component. The identifier will be prefixed with UNIQUE_ID_PREFIX, and will be unique within this UIViewRoot. Optionally, a unique seed value can be supplied by component creators which should be included in the generated unique id. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2975 + Override the default UIComponentBase#encodeBegin behavior. If #getBeforePhaseListener returns non-null, invoke it, passing a PhaseEvent for the PhaseId#RENDER_RESPONSE phase. If the internal list populated by calls to #addPhaseListener is non-empty, any listeners in that list must have their PhaseListener#beforePhase method called, passing the PhaseEvent. Any Exceptions that occur during invocation of any of the beforePhase listeners must be logged and swallowed, unless the #VIEWROOT_PHASE_LISTENER_QUEUES_EXCEPTIONS_PARAM_NAME parameter is set. In that case, the Exception must be passed to the jakarta.faces.context.ExceptionHandler as well. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2976 + + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + JSF:JAVADOC:2977 + If jakarta.faces.context.PartialViewContext#isAjaxRequest returns true, perform partial rendering by calling jakarta.faces.context.PartialViewContext#processPartial with PhaseId#RENDER_RESPONSE. If jakarta.faces.context.PartialViewContext#isAjaxRequest returns false, delegate to the parent jakarta.faces.component.UIComponentBase#encodeChildren method. If this UIViewRoot is an instance of NamingContainer, then the Jakarta Faces implementation must ensure that all encoded POST request parameter names are prefixed with UIViewRoot#getContainerClientId(FacesContext) as per rules of UIComponent#getClientId(FacesContext). This also covers all predefined POST request parameters which are listed below: ResponseStateManager#VIEW_STATE_PARAMResponseStateManager#CLIENT_WINDOW_PARAMResponseStateManager#RENDER_KIT_ID_PARAMClientBehaviorContext#BEHAVIOR_SOURCE_PARAM_NAMEClientBehaviorContext#BEHAVIOR_EVENT_PARAM_NAMEPartialViewContext#PARTIAL_EVENT_PARAM_NAMEPartialViewContext#PARTIAL_EXECUTE_PARAM_NAMEPartialViewContext#PARTIAL_RENDER_PARAM_NAMEPartialViewContext#RESET_VALUES_PARAM_NAME + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2978 + + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + JSF:JAVADOC:2979 + If #getAfterPhaseListener returns non-null, invoke it, passing a PhaseEvent for the PhaseId#RENDER_RESPONSE phase. Any Exceptions that occur during invocation of the afterPhase listener must be logged and swallowed, unless the #VIEWROOT_PHASE_LISTENER_QUEUES_EXCEPTIONS_PARAM_NAME parameter is set. In that case, the Exception must be passed to the jakarta.faces.context.ExceptionHandler as well.. If the current view has view parameters, as indicated by a non-empty and non-UnsupportedOperationException throwing return from jakarta.faces.view.ViewDeclarationLanguage#getViewMetadata(jakarta.faces.context.FacesContext, String), call UIViewParameter#encodeAll on each parameter. If calling getViewParameters() causes UnsupportedOperationException to be thrown, the exception must be silently swallowed. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2980 + + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + + java.io.IOException + + + + + JSF:JAVADOC:2981 + Return the MethodExpression that will be invoked after this view is rendered. + jakarta.faces.component + UIViewRoot + + + + + JSF:JAVADOC:2982 + Return the MethodExpression that will be invoked before this view is rendered. + jakarta.faces.component + UIViewRoot + + + + + JSF:JAVADOC:2983 + Return an unmodifiable List of UIComponents for the provided target agrument. Each component in the List is assumed to represent a resource instance. The default implementation must use an algorithm equivalent to the the following. Locate the facet for the component by calling getFacet() using target as the argument. If the facet is not found, create the facet by calling context.getApplication().createComponent(). The argument to this method must refer to a component that extends UIPanel and overrides the encodeAll() method to take no action. This is necessary to prevent component resources from being inadvertently rendered. Set the id of the facet to be a string created by prepending the literal string #8220;jakarta_faces_location_ #8221; (without the quotes) to the value of the target argument Add the facet to the facets Map using target as the key return the children of the facet + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:2984 + Return an unmodifiable ordered List of all UIComponent resources of all supported targets. Each component in the List is assumed to represent a resource instance. The ordering is the same as the resources would appear in the component tree. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2985 + Return the doctype of this view. + jakarta.faces.component + UIViewRoot + + + + + JSF:JAVADOC:2986 + Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null + jakarta.faces.component + UIViewRoot + + + + + JSF:JAVADOC:2987 + Return the Locale to be used in localizing the response being created for this view. Algorithm: If we have a locale ivar, return it. If we have a value expression for "locale", get its value. If the value is null, return the result of calling jakarta.faces.application.ViewHandler#calculateLocale. If the value is an instance of java.util.Locale return it. If the value is a String, convert it to a java.util.Locale and return it. If there is no value expression for "locale", return the result of calling jakarta.faces.application.ViewHandler#calculateLocale. + jakarta.faces.component + UIViewRoot + + + + + JSF:JAVADOC:2988 + Return an unmodifiable list of the PhaseListener instances attached to this UIViewRoot instance. + jakarta.faces.component + UIViewRoot + + + + + JSF:JAVADOC:2989 + Return the render kit identifier of the jakarta.faces.render.RenderKit associated with this view. Unless explicitly set, as in jakarta.faces.application.ViewHandler#createView, the returned value will be null. + jakarta.faces.component + UIViewRoot + + + + + JSF:JAVADOC:2990 + Call UIComponentBase#getRendersChildren If jakarta.faces.context.PartialViewContext#isAjaxRequest returns true this method must return true. + jakarta.faces.component + UIViewRoot + + + + + JSF:JAVADOC:2991 + Return the view identifier for this view. + jakarta.faces.component + UIViewRoot + + + + + JSF:JAVADOC:2992 + Return the SystemEventListener instances registered on this UIComponent instance that are interested in events of type eventClass. + jakarta.faces.component + UIViewRoot + + + java.lang.Class + + + + + + JSF:JAVADOC:2993 + This implementation simply calls through to #getViewMap(boolean), passing true as the argument, and returns the result. + jakarta.faces.component + UIViewRoot + + + + + JSF:JAVADOC:2994 + Returns a Map that acts as the interface to the data store that is the "view scope", or, if this instance does not have such a Map and the create argument is true, creates one and returns it. This map must be instantiated lazily and cached for return from subsequent calls to this method on this UIViewRoot instance. jakarta.faces.application.Application#publishEvent must be called, passing the current FacesContext as the first argument, PostConstructViewMapEvent.class as the second argument, UIViewRoot.class as the third argument and this UIViewRoot instance as the fourth argument. It is necessary to pass the UIViewRoot.class argument to account for cases when the UIViewRoot has been extended with a custom class. The returned Map must be implemented such that calling clear() on the Map causes jakarta.faces.application.Application#publishEvent to be called, passing PreDestroyViewMapEvent.class as the first argument and this UIViewRoot instance as the second argument. Depending upon application configuration, objects stored in the view map may need to be Serializable. In general, it is a good idea to ensure that any objects stored in the view map are Serializable. For reasons made clear in jakarta.faces.view.ViewScoped, this map must ultimately be stored in the session. For this reason, a true value for the create argument will force the session to be created with a call to jakarta.faces.context.ExternalContext#getSession(boolean). See FacesContext#setViewRoot for the specification of when the clear() method must be called. + jakarta.faces.component + UIViewRoot + + + boolean + + + + + + JSF:JAVADOC:2995 + Override superclass method to always return true because a UIViewRoot is defined to always be in a view. + jakarta.faces.component + UIViewRoot + + + + + JSF:JAVADOC:2996 + Broadcast any events that have been queued for the Invoke Application phase of the request processing lifecycle and to clear out any events for later phases if the event processing for this phase caused FacesContext#renderResponse or FacesContext#responseComplete to be called. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2997 + Perform partial processing by calling jakarta.faces.context.PartialViewContext#processPartial with PhaseId#APPLY_REQUEST_VALUES if: jakarta.faces.context.PartialViewContext#isPartialRequest returns true and we don't have a request to process all components in the view (jakarta.faces.context.PartialViewContext#isExecuteAll returns false) Perform full processing by calling UIComponentBase#processDecodes if one of the following conditions are met: jakarta.faces.context.PartialViewContext#isPartialRequest returns true and we have a request to process all components in the view (jakarta.faces.context.PartialViewContext#isExecuteAll returns true) jakarta.faces.context.PartialViewContext#isPartialRequest returns false Override the default UIComponentBase#processDecodes behavior to broadcast any queued events after the default processing or partial processing has been completed and to clear out any events for later phases if the event processing for this phase caused FacesContext#renderResponse or FacesContext#responseComplete to be called. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:2998 + If the argument event is an instance of PostRestoreStateEvent and PartialViewContext#isPartialRequest() returns true, then loop over all component resources and call ResourceHandler#markResourceRendered(FacesContext, String, String) for each of them. Finally, delegate to super. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.event.ComponentSystemEvent + + + + + + JSF:JAVADOC:2999 + + jakarta.faces.component + UIViewRoot + + + jakarta.faces.event.ComponentSystemEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:3000 + The default implementation must call UIComponentBase#processRestoreState from within a try block. The try block must have a finally block that ensures that no FacesEvents remain in the event queue. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:3001 + Perform partial processing by calling jakarta.faces.context.PartialViewContext#processPartial with PhaseId#UPDATE_MODEL_VALUES if: jakarta.faces.context.PartialViewContext#isPartialRequest returns true and we don't have a request to process all components in the view (jakarta.faces.context.PartialViewContext#isExecuteAll returns false) Perform full processing by calling UIComponentBase#processUpdates if one of the following conditions are met: jakarta.faces.context.PartialViewContext#isPartialRequest returns true and we have a request to process all components in the view (jakarta.faces.context.PartialViewContext#isExecuteAll returns true) jakarta.faces.context.PartialViewContext#isPartialRequest returns false Override the default UIComponentBase behavior to broadcast any queued events after the default processing or partial processing has been completed and to clear out any events for later phases if the event processing for this phase caused FacesContext#renderResponse or FacesContext#responseComplete to be called. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:3002 + Perform partial processing by calling jakarta.faces.context.PartialViewContext#processPartial with PhaseId#PROCESS_VALIDATIONS if: jakarta.faces.context.PartialViewContext#isPartialRequest returns true and we don't have a request to process all components in the view (jakarta.faces.context.PartialViewContext#isExecuteAll returns false) Perform full processing by calling UIComponentBase#processValidators if one of the following conditions are met: jakarta.faces.context.PartialViewContext#isPartialRequest returns true and we have a request to process all components in the view (jakarta.faces.context.PartialViewContext#isExecuteAll returns true) jakarta.faces.context.PartialViewContext#isPartialRequest returns false Override the default UIComponentBase#processValidators behavior to broadcast any queued events after the default processing or partial processing has been completed and to clear out any events for later phases if the event processing for this phase caused FacesContext#renderResponse or FacesContext#responseComplete to be called. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:3003 + Override the default UIComponentBase#queueEvent behavior to accumulate the queued events for later broadcasting. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.event.FacesEvent + + + + + + JSF:JAVADOC:3004 + Remove argument component, which is assumed to represent a resource instance, as a resource to this view. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:3005 + Remove argument component, which is assumed to represent a resource instance, as a resource to this view. A resource instance is rendered by a resource Renderer, as described in the Standard HTML RenderKit. The component must be removed using the following algorithm: If the target argument is null, look for a target attribute on the component. If there is no target attribute, set target to be the default value head Call #getComponentResources to obtain the child list for the given target. Remove the component resource from the child list. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:3006 + If the argument toRemove is in the list of PhaseListeners for this instance, it must be removed. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.event.PhaseListener + + + + + + JSF:JAVADOC:3007 + Visit the clientIds and, if the component is an instance of EditableValueHolder, call its EditableValueHolder#resetValue method. Use #visitTree to do the visiting. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + java.util.Collection + + + + + + JSF:JAVADOC:3008 + + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:3009 + Restore ViewScope state. This is needed to allow the use of view scoped beans for EL-expressions in the template from which the component tree is built. For example: . + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:3010 + + jakarta.faces.component + UIViewRoot + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:3011 + Allow an arbitrary method to be called for the "afterPhase" event as the UIViewRoot runs through its lifecycle. This method will be called for all phases including PhaseId#RESTORE_VIEW. Unlike a true PhaseListener, this approach doesn't allow for only receiving PhaseEvents for a given phase. The method must conform to the signature of PhaseListener#afterPhase. + jakarta.faces.component + UIViewRoot + + + jakarta.el.MethodExpression + + + + + + JSF:JAVADOC:3012 + Allow an arbitrary method to be called for the "beforePhase" event as the UIViewRoot runs through its lifecycle. This method will be called for all phases except PhaseId#RESTORE_VIEW. Unlike a true PhaseListener, this approach doesn't allow for only receiving PhaseEvents for a given phase. The method must conform to the signature of PhaseListener#beforePhase. + jakarta.faces.component + UIViewRoot + + + jakarta.el.MethodExpression + + + + + + JSF:JAVADOC:3013 + Set the doctype of this view. + jakarta.faces.component + UIViewRoot + + + jakarta.faces.component.Doctype + + + + + + JSF:JAVADOC:3014 + Overridden to take no action. + jakarta.faces.component + UIViewRoot + + + boolean + + + + + + JSF:JAVADOC:3015 + Set the Locale to be used in localizing the response being created for this view. + jakarta.faces.component + UIViewRoot + + + java.util.Locale + + + + + + JSF:JAVADOC:3016 + Set the render kit identifier of the jakarta.faces.render.RenderKit associated with this view. This method may be called at any time between the end of Apply Request Values phase of the request processing lifecycle (i.e. when events are being broadcast) and the beginning of the Render Response phase. + jakarta.faces.component + UIViewRoot + + + java.lang.String + + + + + + JSF:JAVADOC:3017 + Set the view identifier for this view. + jakarta.faces.component + UIViewRoot + + + java.lang.String + + + + + + JSF:JAVADOC:3018 + Install the listener instance referenced by argument listener into the UIViewRoot as a listener for events of type systemEventClass. Note that installed listeners are not maintained as part of the UIViewRoot's state. + jakarta.faces.component + UIViewRoot + + + java.lang.Class + jakarta.faces.event.SystemEventListener + + + + + + JSF:JAVADOC:3019 + Create a new UIViewRoot instance with default property values. + jakarta.faces.component + UIViewRoot + + + + + JSF:JAVADOC:3020 + Remove the listener instance referenced by argument listener from the UIViewRoot as a listener for events of type systemEventClass. + jakarta.faces.component + UIViewRoot + + + java.lang.Class + jakarta.faces.event.SystemEventListener + + + + + + JSF:JAVADOC:3021 + Returns the name of the websocket channel. + jakarta.faces.component + UIWebsocket + + + + + JSF:JAVADOC:3022 + Returns a non-null, empty, unmodifiable Collection which returns true on any Collection#contains() invocation, indicating that all client behavior event names are acceptable. + jakarta.faces.component + UIWebsocket + + + + + JSF:JAVADOC:3023 + Returns UIWebsocket#COMPONENT_FAMILY. + jakarta.faces.component + UIWebsocket + + + + + JSF:JAVADOC:3024 + Returns the JavaScript event handler function that is invoked when the websocket is closed and will not anymore attempt to reconnect. + jakarta.faces.component + UIWebsocket + + + + + JSF:JAVADOC:3025 + Returns the JavaScript event handler function that is invoked when a connection error has occurred and the websocket will attempt to reconnect. + jakarta.faces.component + UIWebsocket + + + + + JSF:JAVADOC:3026 + Returns the JavaScript event handler function that is invoked when a push message is received from the server. + jakarta.faces.component + UIWebsocket + + + + + JSF:JAVADOC:3027 + Returns the JavaScript event handler function that is invoked when the websocket is opened. + jakarta.faces.component + UIWebsocket + + + + + JSF:JAVADOC:3028 + Returns the scope of the websocket channel. + jakarta.faces.component + UIWebsocket + + + + + JSF:JAVADOC:3029 + Returns the user identifier of the websocket channel. + jakarta.faces.component + UIWebsocket + + + + + JSF:JAVADOC:3030 + Returns whether to (auto)connect the websocket or not. + jakarta.faces.component + UIWebsocket + + + + + JSF:JAVADOC:3031 + Sets the name of the websocket channel. It may not be an Jakarta Expression Language expression and it may only contain alphanumeric characters, hyphens, underscores and periods. All open websockets on the same channel will receive the same push message from the server. + jakarta.faces.component + UIWebsocket + + + java.lang.String + + + + + + JSF:JAVADOC:3032 + Sets whether to (auto)connect the websocket or not. Defaults to true. It's interpreted as a JavaScript instruction whether to open or close the websocket push connection. Note that this attribute is re-evaluated on every ajax request. You can also explicitly set it to false and then manually control in JavaScript by faces.push.open("channelName") and faces.push.close("channelName"). + jakarta.faces.component + UIWebsocket + + + boolean + + + + + + JSF:JAVADOC:3033 + Sets the JavaScript event handler function that is invoked when the websocket is closed and will not anymore attempt to reconnect. The function will be invoked with three arguments: the close reason code, the channel name and the raw CloseEvent itself. Note that this will also be invoked when the close is caused by an error and that you can inspect the close reason code if an actual connection error occurred and which one (i.e. when the code is not 1000 or 1008). See also RFC 6455 section 7.4.1 and CloseCodes API for an elaborate list of all close codes. + jakarta.faces.component + UIWebsocket + + + java.lang.String + + + + + + JSF:JAVADOC:3034 + Sets the JavaScript event handler function that is invoked when a connection error has occurred and the websocket will attempt to reconnect. The function will be invoked with three arguments: the error reason code, the channel name and the raw CloseEvent itself. Note that this will not be invoked on final close of the websocket, even when the final close is caused by an error. See also RFC 6455 section 7.4.1 and CloseCodes API for an elaborate list of all close codes. + jakarta.faces.component + UIWebsocket + + + java.lang.String + + + + + + JSF:JAVADOC:3035 + Sets the JavaScript event handler function that is invoked when a push message is received from the server. The function will be invoked with three arguments: the push message, the channel name and the raw MessageEvent itself. + jakarta.faces.component + UIWebsocket + + + java.lang.String + + + + + + JSF:JAVADOC:3036 + Sets the JavaScript event handler function that is invoked when the websocket is opened. The function will be invoked with one argument: the channel name. + jakarta.faces.component + UIWebsocket + + + java.lang.String + + + + + + JSF:JAVADOC:3037 + Sets the scope of the websocket channel. It may not be an Jakarta Expression Language expression and allowed values are application, session and view, case insensitive. When the value is application, then all channels with the same name throughout the application will receive the same push message. When the value is session, then only the channels with the same name in the current user session will receive the same push message. When the value is view, then only the channel in the current view will receive the push message. The default scope is application. When the user attribute is specified, then the default scope is session. + jakarta.faces.component + UIWebsocket + + + java.lang.String + + + + + + JSF:JAVADOC:3038 + Sets the user identifier of the websocket channel, so that user-targeted push messages can be sent. All open websockets on the same channel and user will receive the same push message from the server. It must implement Serializable and preferably have low memory footprint. Suggestion: use #{request.remoteUser} or #{someLoggedInUser.id}. + jakarta.faces.component + UIWebsocket + + + java.io.Serializable + + + + + + JSF:JAVADOC:3039 + Set the ValueExpression used to calculate the value for the specified attribute or property name, if any. If a ValueExpression is set for the channel or scope property, regardless of the value, throw an illegal argument exception. If a ValueExpression is set for the user property, and the non-null value is not an instance of Serializable, throw an illegal argument exception. + jakarta.faces.component + UIWebsocket + + + java.lang.String + jakarta.el.ValueExpression + + + + + + JSF:JAVADOC:3040 + Create a new UIWebsocket instance with default property values. + jakarta.faces.component + UIWebsocket + + + + + JSF:JAVADOC:3041 + Generate an identifier for a component. The identifier will be prefixed with UNIQUE_ID_PREFIX, and will be unique within this component-container. Optionally, a unique seed value can be supplied by component creators which should be included in the generated unique id. + jakarta.faces.component + UniqueIdVendor + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:3042 + Return the FacesMessage passed to the constructor. + jakarta.faces.component + UpdateModelException + + + + + JSF:JAVADOC:3043 + Store the argument facesMessage so it may be returned from #getFacesMessage and pass the argument cause to the super constructor. + jakarta.faces.component + UpdateModelException + + + jakarta.faces.application.FacesMessage + java.lang.Throwable + + + + + + JSF:JAVADOC:3044 + Return the Converter (if any) that is registered for this UIComponent. + jakarta.faces.component + ValueHolder + + + + + JSF:JAVADOC:3045 + Return the local value of this UIComponent (if any), without evaluating any associated ValueExpression. + jakarta.faces.component + ValueHolder + + + + + JSF:JAVADOC:3046 + Gets the value of this UIComponent. If validation failed, as indicated by jakarta.faces.context.FacesContext#isValidationFailed returning true, always return the local value. Otherwise, first, consult the local value property of this component. If non-null return it. If null, see if we have a ValueExpression for the value property. If so, return the result of evaluating the property, otherwise return null. + jakarta.faces.component + ValueHolder + + + + + JSF:JAVADOC:3047 + Set the Converter (if any) that is registered for this UIComponent. + jakarta.faces.component + ValueHolder + + + jakarta.faces.convert.Converter + + + + + + JSF:JAVADOC:3048 + Set the value of this UIComponent (if any). + jakarta.faces.component + ValueHolder + + + java.lang.Object + + + + + + JSF:JAVADOC:3049 + Add the specified AjaxBehaviorListener to the set of listeners registered to receive event notifications from this AjaxBehavior. + jakarta.faces.component.behavior + AjaxBehavior + + + jakarta.faces.event.AjaxBehaviorListener + + + + + + JSF:JAVADOC:3050 + Default constructor that just creates this instance. + jakarta.faces.component.behavior + AjaxBehavior + + + + + JSF:JAVADOC:3051 + Returns the delay value, or null if no value was set. + jakarta.faces.component.behavior + AjaxBehavior + + + + + JSF:JAVADOC:3052 + Return a non-empty Collection of component identifiers that will be used to identify components that should be processed during the execute phase of the request processing lifecycle. Note that the returned collection may be unmodifiable. Modifications should be performed by calling #setExecute. + jakarta.faces.component.behavior + AjaxBehavior + + + + + JSF:JAVADOC:3053 + This method returns an unmodifiable Set containing the ClientBehaviorHint SUBMITTING. + jakarta.faces.component.behavior + AjaxBehavior + + + + + JSF:JAVADOC:3054 + Return the String of JavaScript function name that will be used to identify the client callback function that should be run in the event of an error. + jakarta.faces.component.behavior + AjaxBehavior + + + + + JSF:JAVADOC:3055 + Return the String of JavaScript function name that will be used to identify the client callback function that should be run on the occurance of a client-side event. + jakarta.faces.component.behavior + AjaxBehavior + + + + + JSF:JAVADOC:3056 + Return a non-empty Collection of component identifiers that will be used to identify components that should be processed during the render phase of the request processing lifecycle. Note that the returned collection may be unmodifiable. Modifications should be performed by calling #setRender. + jakarta.faces.component.behavior + AjaxBehavior + + + + + JSF:JAVADOC:3057 + Returns the renderer type of the ClientBehaviorRenderer to use for the behavior. The default implementation returns null. Subclasses should either override this method to return a string that identifies the type of ClientBehaviorRenderer to use, or should override #getScript and perform script rendering locally in the ClientBehavior implementation. + jakarta.faces.component.behavior + AjaxBehavior + + + + + JSF:JAVADOC:3058 + Returns the ValueExpression used to calculate the value for the specified property name, if any. + jakarta.faces.component.behavior + AjaxBehavior + + + java.lang.String + + + + + + JSF:JAVADOC:3059 + Return the disabled status of this behavior. + jakarta.faces.component.behavior + AjaxBehavior + + + + + JSF:JAVADOC:3060 + Return the immediate status of this behavior. + jakarta.faces.component.behavior + AjaxBehavior + + + + + JSF:JAVADOC:3061 + Tests whether the immediate attribute is specified. Returns true if the immediate attribute is specified, either as a locally set property or as a value expression. This information allows an associated client behavior renderer to fall back on the parent component's immediate status when immediate is not explicitly specified on the AjaxBehavior. + jakarta.faces.component.behavior + AjaxBehavior + + + + + JSF:JAVADOC:3062 + Return the resetValues status of this behavior. + jakarta.faces.component.behavior + AjaxBehavior + + + + + JSF:JAVADOC:3063 + Tests whether the resetValues attribute is specified. Returns true if the resetValues attribute is specified, either as a locally set property or as a value expression. + jakarta.faces.component.behavior + AjaxBehavior + + + + + JSF:JAVADOC:3064 + Remove the specified AjaxBehaviorListener from the set of listeners registered to receive event notifications from this AjaxBehavior. + jakarta.faces.component.behavior + AjaxBehavior + + + jakarta.faces.event.AjaxBehaviorListener + + + + + + JSF:JAVADOC:3065 + Implementation of jakarta.faces.component.StateHolder#restoreState. + jakarta.faces.component.behavior + AjaxBehavior + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:3066 + Implementation of jakarta.faces.component.StateHolder#saveState. + jakarta.faces.component.behavior + AjaxBehavior + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:3067 + If less than delay milliseconds elapses between calls to request() only the most recent one is sent and all other requests are discarded. The default value of this option is 300. If the value of delay is the literal string 'none' without the quotes, no delay is used. + jakarta.faces.component.behavior + AjaxBehavior + + + java.lang.String + + + + + + JSF:JAVADOC:3068 + Sets the disabled status of this behavior. + jakarta.faces.component.behavior + AjaxBehavior + + + boolean + + + + + + JSF:JAVADOC:3069 + Sets the component identifiers that will be used to identify components that should be processed during the execute phase of the request processing lifecycle. + jakarta.faces.component.behavior + AjaxBehavior + + + java.util.Collection + + + + + + JSF:JAVADOC:3070 + Sets the immediate status of this behavior. + jakarta.faces.component.behavior + AjaxBehavior + + + boolean + + + + + + JSF:JAVADOC:3071 + Sets the JavaScript function name that will be used to identify the client callback function that should be run in the event of an error. + jakarta.faces.component.behavior + AjaxBehavior + + + java.lang.String + + + + + + JSF:JAVADOC:3072 + Sets the JavaScript function name that will be used to identify the client callback function that should be run in response to event activity. + jakarta.faces.component.behavior + AjaxBehavior + + + java.lang.String + + + + + + JSF:JAVADOC:3073 + Sets the component identifiers that will be used to identify components that should be processed during the render phase of the request processing lifecycle. + jakarta.faces.component.behavior + AjaxBehavior + + + java.util.Collection + + + + + + JSF:JAVADOC:3074 + Set the resetValues status of this behavior. + jakarta.faces.component.behavior + AjaxBehavior + + + boolean + + + + + + JSF:JAVADOC:3075 + Sets the ValueExpression used to calculate the value for the specified property name. + jakarta.faces.component.behavior + AjaxBehavior + + + java.lang.String + jakarta.el.ValueExpression + + + + + + JSF:JAVADOC:3076 + Broadcast the specified BehaviorEvent to all registered event listeners who have expressed an interest in events of this type. Listeners are called in the order in which they were added. + jakarta.faces.component.behavior + Behavior + + + jakarta.faces.event.BehaviorEvent + + + + + + JSF:JAVADOC:3077 + + jakarta.faces.component.behavior + BehaviorBase + + + + + JSF:JAVADOC:3078 + Default implementation of Behavior#broadcast. Delivers the specified BehaviorEvent to all registered BehaviorListener event listeners who have expressed an interest in events of this type. Listeners are called in the order in which they were registered (added). + jakarta.faces.component.behavior + BehaviorBase + + + jakarta.faces.event.BehaviorEvent + + + + + + JSF:JAVADOC:3079 + Signal the Jakarta Faces implementation that no further processing on the current event should be performed + jakarta.faces.component.behavior + BehaviorBase + + + jakarta.faces.event.BehaviorEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:3080 + Clears the initial state flag, causing the behavior to revert from partial to full state saving. + jakarta.faces.component.behavior + BehaviorBase + + + + + JSF:JAVADOC:3081 + Implementation of jakarta.faces.component.PartialStateHolder#initialStateMarked. + jakarta.faces.component.behavior + BehaviorBase + + + + + JSF:JAVADOC:3082 + Implementation of jakarta.faces.component.StateHolder#isTransient. + jakarta.faces.component.behavior + BehaviorBase + + + + + JSF:JAVADOC:3083 + Implementation of jakarta.faces.component.PartialStateHolder#markInitialState. + jakarta.faces.component.behavior + BehaviorBase + + + + + JSF:JAVADOC:3084 + Implementation of jakarta.faces.component.StateHolder#restoreState. + jakarta.faces.component.behavior + BehaviorBase + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:3085 + Implementation of jakarta.faces.component.StateHolder#saveState. + jakarta.faces.component.behavior + BehaviorBase + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:3086 + Implementation of jakarta.faces.component.StateHolder#setTransient. + jakarta.faces.component.behavior + BehaviorBase + + + boolean + + + + + + JSF:JAVADOC:3087 + Decode any new state of this ClientBehavior from the request contained in the specified FacesContext. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling queueEvent(). Default implementation delegates decoding to jakarta.faces.render.ClientBehaviorRenderer#decode(FacesContext, UIComponent, ClientBehavior) + jakarta.faces.component.behavior + ClientBehavior + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:3088 + Returns hints that describe the behavior of the ClientBehavior implementation. The hints may impact how Renderers behave in the presence of Behaviors. For example, when a Behavior that specifies ClientBehaviorHint.SUBMITTING is present, the Renderer may choose to alternate the scripts that it generates itself. + jakarta.faces.component.behavior + ClientBehavior + + + + + JSF:JAVADOC:3089 + Return the script that implements this ClientBehavior's client-side logic. ClientBehavior.getScript() implementations are allowed to return null to indicate that no script is required for this particular getScript() call. For example, a ClientBehavior implementation may return null if the Behavior is disabled. + jakarta.faces.component.behavior + ClientBehavior + + + jakarta.faces.component.behavior.ClientBehaviorContext + + + + + + JSF:JAVADOC:3090 + + jakarta.faces.component.behavior + ClientBehaviorBase + + + + + JSF:JAVADOC:3091 + Default implementation of of ClientBehavior#decode. If a ClientBehaviorRenderer is available for the specified behavior renderer type, this method delegates to the ClientBehaviorRenderer's decode() method. Otherwise, no decoding is performed. + jakarta.faces.component.behavior + ClientBehaviorBase + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:3092 + Default implementation of ClientBehavior#getHints(). By default, no hints are specified, and this method returns an empty, umodifiable set. + jakarta.faces.component.behavior + ClientBehaviorBase + + + + + JSF:JAVADOC:3093 + Returns the renderer type of the ClientBehaviorRenderer to use for the behavior. The default implementation returns null. Subclasses should either override this method to return a string that identifies the type of ClientBehaviorRenderer to use, or should override #getScript and perform script rendering locally in the ClientBehavior implementation. + jakarta.faces.component.behavior + ClientBehaviorBase + + + + + JSF:JAVADOC:3094 + Default implementation of of ClientBehavior#getScript. If a ClientBehaviorRenderer is available for the specified behavior renderer type, this method delegates to the ClientBehaviorRenderer#getScript method. Otherwise, this method returns null. + jakarta.faces.component.behavior + ClientBehaviorBase + + + jakarta.faces.component.behavior.ClientBehaviorContext + + + + + + JSF:JAVADOC:3095 + + jakarta.faces.component.behavior + ClientBehaviorContext + + + + + JSF:JAVADOC:3096 + Creates a ClientBehaviorContext instance. + jakarta.faces.component.behavior + ClientBehaviorContext + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + java.lang.String + java.util.Collection + + + + + + JSF:JAVADOC:3097 + Returns the UIComponent that is requesting the ClientBehavior script. + jakarta.faces.component.behavior + ClientBehaviorContext + + + + + JSF:JAVADOC:3098 + Returns the name of the behavior event for which the ClientBehavior script is being requested. + jakarta.faces.component.behavior + ClientBehaviorContext + + + + + JSF:JAVADOC:3099 + Returns the FacesContext for the current request. + jakarta.faces.component.behavior + ClientBehaviorContext + + + + + JSF:JAVADOC:3100 + Returns parameters that "submitting" ClientBehavior implementations should include when posting back data into the Faces lifecycle. If no parameters are specified, this method returns an empty (non-null) collection. + jakarta.faces.component.behavior + ClientBehaviorContext + + + + + JSF:JAVADOC:3101 + Returns an id for use as the ClientBehavior source. ClientBehavior implementations that submit back to the Faces lifecycle are required to identify which component triggered the ClientBehavior-initiated request via the jakarta.faces.source request parameter. In most cases, th source id can be trivially derived from the element to which the behavior's client-side script is attached - ie. the source id is typically the id of this element. However, in components which produce more complex content, the behavior script may not be able to determine the correct id to use for the jakarta.faces.source value. The ClientBehaviorContext#getSourceId method allows the component to pass this information into the ClientBehavior#getScript implementation. + jakarta.faces.component.behavior + ClientBehaviorContext + + + + + JSF:JAVADOC:3102 + Creates a Parameter instance. + jakarta.faces.component.behavior + ClientBehaviorContext.Parameter + + + java.lang.String + java.lang.Object + + + + + + JSF:JAVADOC:3103 + Returns the Parameter's name. + jakarta.faces.component.behavior + ClientBehaviorContext.Parameter + + + + + JSF:JAVADOC:3104 + Returns the Parameter's value. + jakarta.faces.component.behavior + ClientBehaviorContext.Parameter + + + + + JSF:JAVADOC:3105 + + jakarta.faces.component.behavior + ClientBehaviorHint + + + java.lang.String + + + + + + JSF:JAVADOC:3106 + + jakarta.faces.component.behavior + ClientBehaviorHint + + + + + JSF:JAVADOC:3107 + Attaches a ClientBehavior to the component implementing this interface for the specified event. Valid event names for a UIComponent implementation are defined by ClientBehaviorHolder.getEventNames(). + jakarta.faces.component.behavior + ClientBehaviorHolder + + + java.lang.String + jakarta.faces.component.behavior.ClientBehavior + + + + + + JSF:JAVADOC:3108 + Returns a non-null, unmodifiable Map that contains the the ClientBehaviors that have been attached to the component implementing this interface. The keys in this Map are event names defined by #getEventNames. + jakarta.faces.component.behavior + ClientBehaviorHolder + + + + + JSF:JAVADOC:3109 + Returns the default event name for this ClientBehaviorHolder implementation. This must be one of the event names returned by #getEventNames or null if the component does not have a default event. + jakarta.faces.component.behavior + ClientBehaviorHolder + + + + + JSF:JAVADOC:3110 + Returns a non-null, unmodifiable Collection containing the names of the logical events supported by the component implementing this interface. + jakarta.faces.component.behavior + ClientBehaviorHolder + + + + + JSF:JAVADOC:3111 + The value of this annotation attribute is taken to be an indicator that flags whether or not the given converter is a CDI managed converter. + jakarta.faces.component.behavior + FacesBehavior + + + + + JSF:JAVADOC:3112 + The value of this annotation attribute is taken to be the behavior-id with which instances of this class of behavior can be instantiated. + jakarta.faces.component.behavior + FacesBehavior + + + + + JSF:JAVADOC:3113 + The value of this annotation attribute is taken to be an indicator that flags whether or not the given converter is a CDI managed converter. + jakarta.faces.component.behavior + FacesBehavior.Literal + + + + + JSF:JAVADOC:3114 + + jakarta.faces.component.behavior + FacesBehavior.Literal + + + java.lang.String + boolean + + + + + + JSF:JAVADOC:3115 + The value of this annotation attribute is taken to be the behavior-id with which instances of this class of behavior can be instantiated. + jakarta.faces.component.behavior + FacesBehavior.Literal + + + + + JSF:JAVADOC:3116 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3117 + Return the value of the dir property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3118 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3119 + Return the value of the lang property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3120 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3121 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3122 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3123 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3124 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3125 + Return the value of the onload property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3126 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3127 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3128 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3129 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3130 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3131 + Return the value of the onunload property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3132 + Return the value of the role property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3133 + Return the value of the style property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3134 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3135 + Return the value of the title property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3136 + Return the value of the xmlns property. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3137 + Default constructor setting the renderer type. + jakarta.faces.component.html + HtmlBody + + + + + JSF:JAVADOC:3138 + Set the value of the dir property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3139 + Set the value of the lang property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3140 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3141 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3142 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3143 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3144 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3145 + Set the value of the onload property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3146 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3147 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3148 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3149 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3150 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3151 + Set the value of the onunload property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3152 + Set the value of the role property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3153 + Set the value of the style property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3154 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3155 + Set the value of the title property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3156 + Set the value of the xmlns property. + jakarta.faces.component.html + HtmlBody + + + java.lang.String + + + + + + JSF:JAVADOC:3157 + + jakarta.faces.component.html + HtmlBody.PropertyKeys + + + + + JSF:JAVADOC:3158 + + jakarta.faces.component.html + HtmlBody.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3159 + + jakarta.faces.component.html + HtmlBody.PropertyKeys + + + + + JSF:JAVADOC:3160 + Return the value of the footerClass property. + jakarta.faces.component.html + HtmlColumn + + + + + JSF:JAVADOC:3161 + Return the value of the headerClass property. + jakarta.faces.component.html + HtmlColumn + + + + + JSF:JAVADOC:3162 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlColumn + + + + + JSF:JAVADOC:3163 + + jakarta.faces.component.html + HtmlColumn + + + + + JSF:JAVADOC:3164 + Return the value of the rowHeader property. + jakarta.faces.component.html + HtmlColumn + + + + + JSF:JAVADOC:3165 + Set the value of the footerClass property. + jakarta.faces.component.html + HtmlColumn + + + java.lang.String + + + + + + JSF:JAVADOC:3166 + Set the value of the headerClass property. + jakarta.faces.component.html + HtmlColumn + + + java.lang.String + + + + + + JSF:JAVADOC:3167 + Set the value of the rowHeader property. + jakarta.faces.component.html + HtmlColumn + + + boolean + + + + + + JSF:JAVADOC:3168 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlColumn + + + java.lang.String + + + + + + JSF:JAVADOC:3169 + + jakarta.faces.component.html + HtmlColumn.PropertyKeys + + + + + JSF:JAVADOC:3170 + + jakarta.faces.component.html + HtmlColumn.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3171 + + jakarta.faces.component.html + HtmlColumn.PropertyKeys + + + + + JSF:JAVADOC:3172 + Return the value of the accesskey property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3173 + Return the value of the alt property. This attribute is ignored when the image attribute is not specified. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3174 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3175 + Return the value of the dir property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3176 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3177 + Return the value of the image property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3178 + Return the value of the label property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3179 + Return the value of the lang property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3180 + Return the value of the onblur property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3181 + Return the value of the onchange property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3182 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3183 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3184 + Return the value of the onfocus property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3185 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3186 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3187 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3188 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3189 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3190 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3191 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3192 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3193 + Return the value of the onselect property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3194 + Return the value of the role property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3195 + Return the value of the style property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3196 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3197 + Return the value of the tabindex property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3198 + Return the value of the title property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3199 + Return the value of the type property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3200 + + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3201 + Return the value of the disabled property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3202 + Return the value of the readonly property. + jakarta.faces.component.html + HtmlCommandButton + + + + + JSF:JAVADOC:3203 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3204 + Set the value of the alt property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3205 + Set the value of the dir property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3206 + Set the value of the disabled property. + jakarta.faces.component.html + HtmlCommandButton + + + boolean + + + + + + JSF:JAVADOC:3207 + Set the value of the image property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3208 + Set the value of the label property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3209 + Set the value of the lang property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3210 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3211 + Set the value of the onchange property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3212 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3213 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3214 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3215 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3216 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3217 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3218 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3219 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3220 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3221 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3222 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3223 + Set the value of the onselect property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3224 + Set the value of the readonly property. + jakarta.faces.component.html + HtmlCommandButton + + + boolean + + + + + + JSF:JAVADOC:3225 + Set the value of the role property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3226 + Set the value of the style property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3227 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3228 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3229 + Set the value of the title property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3230 + Set the value of the type property. + jakarta.faces.component.html + HtmlCommandButton + + + java.lang.String + + + + + + JSF:JAVADOC:3231 + + jakarta.faces.component.html + HtmlCommandButton.PropertyKeys + + + + + JSF:JAVADOC:3232 + + jakarta.faces.component.html + HtmlCommandButton.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3233 + + jakarta.faces.component.html + HtmlCommandButton.PropertyKeys + + + + + JSF:JAVADOC:3234 + Return the value of the accesskey property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3235 + Return the value of the charset property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3236 + Return the value of the coords property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3237 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3238 + Return the value of the dir property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3239 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3240 + Return the value of the hreflang property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3241 + Return the value of the lang property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3242 + Return the value of the onblur property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3243 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3244 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3245 + Return the value of the onfocus property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3246 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3247 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3248 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3249 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3250 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3251 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3252 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3253 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3254 + Return the value of the rel property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3255 + Return the value of the rev property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3256 + Return the value of the role property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3257 + Return the value of the shape property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3258 + Return the value of the style property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3259 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3260 + Return the value of the tabindex property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3261 + Return the value of the target property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3262 + Return the value of the title property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3263 + Return the value of the type property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3264 + + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3265 + Return the value of the disabled property. + jakarta.faces.component.html + HtmlCommandLink + + + + + JSF:JAVADOC:3266 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3267 + Set the value of the charset property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3268 + Set the value of the coords property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3269 + Set the value of the dir property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3270 + Set the value of the disabled property. + jakarta.faces.component.html + HtmlCommandLink + + + boolean + + + + + + JSF:JAVADOC:3271 + Set the value of the hreflang property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3272 + Set the value of the lang property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3273 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3274 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3275 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3276 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3277 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3278 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3279 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3280 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3281 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3282 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3283 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3284 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3285 + Set the value of the rel property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3286 + Set the value of the rev property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3287 + Set the value of the role property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3288 + Set the value of the shape property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3289 + Set the value of the style property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3290 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3291 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3292 + Set the value of the target property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3293 + Set the value of the title property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3294 + Set the value of the type property. + jakarta.faces.component.html + HtmlCommandLink + + + java.lang.String + + + + + + JSF:JAVADOC:3295 + + jakarta.faces.component.html + HtmlCommandLink.PropertyKeys + + + + + JSF:JAVADOC:3296 + + jakarta.faces.component.html + HtmlCommandLink.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3297 + + jakarta.faces.component.html + HtmlCommandLink.PropertyKeys + + + + + JSF:JAVADOC:3298 + Return the value of the execute property. + jakarta.faces.component.html + HtmlCommandScript + + + + + JSF:JAVADOC:3299 + Return the value of the name property. + jakarta.faces.component.html + HtmlCommandScript + + + + + JSF:JAVADOC:3300 + Return the value of the onerror property. + jakarta.faces.component.html + HtmlCommandScript + + + + + JSF:JAVADOC:3301 + Return the value of the onevent property. + jakarta.faces.component.html + HtmlCommandScript + + + + + JSF:JAVADOC:3302 + Return the value of the render property. + jakarta.faces.component.html + HtmlCommandScript + + + + + JSF:JAVADOC:3303 + Return the value of the resetValues property. + jakarta.faces.component.html + HtmlCommandScript + + + + + JSF:JAVADOC:3304 + + jakarta.faces.component.html + HtmlCommandScript + + + + + JSF:JAVADOC:3305 + Return the value of the autorun property. + jakarta.faces.component.html + HtmlCommandScript + + + + + JSF:JAVADOC:3306 + Set the value of the autorun property. + jakarta.faces.component.html + HtmlCommandScript + + + boolean + + + + + + JSF:JAVADOC:3307 + Set the value of the execute property. + jakarta.faces.component.html + HtmlCommandScript + + + java.lang.String + + + + + + JSF:JAVADOC:3308 + Set the value of the name property. + jakarta.faces.component.html + HtmlCommandScript + + + java.lang.String + + + + + + JSF:JAVADOC:3309 + Set the value of the onerror property. + jakarta.faces.component.html + HtmlCommandScript + + + java.lang.String + + + + + + JSF:JAVADOC:3310 + Set the value of the onevent property. + jakarta.faces.component.html + HtmlCommandScript + + + java.lang.String + + + + + + JSF:JAVADOC:3311 + Set the value of the render property. + jakarta.faces.component.html + HtmlCommandScript + + + java.lang.String + + + + + + JSF:JAVADOC:3312 + Set the value of the resetValues property. + jakarta.faces.component.html + HtmlCommandScript + + + java.lang.Boolean + + + + + + JSF:JAVADOC:3313 + + jakarta.faces.component.html + HtmlCommandScript.PropertyKeys + + + + + JSF:JAVADOC:3314 + + jakarta.faces.component.html + HtmlCommandScript.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3315 + + jakarta.faces.component.html + HtmlCommandScript.PropertyKeys + + + + + JSF:JAVADOC:3316 + Return the value of the bgcolor property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3317 + Return the value of the bodyrows property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3318 + Return the value of the border property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3319 + Return the value of the captionClass property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3320 + Return the value of the captionStyle property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3321 + Return the value of the cellpadding property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3322 + Return the value of the cellspacing property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3323 + Return the value of the columnClasses property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3324 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3325 + Return the value of the dir property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3326 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3327 + Return the value of the footerClass property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3328 + Return the value of the frame property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3329 + Return the value of the headerClass property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3330 + Return the value of the lang property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3331 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3332 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3333 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3334 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3335 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3336 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3337 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3338 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3339 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3340 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3341 + Return the value of the role property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3342 + Return the value of the rowClass property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3343 + Return the value of the rowClasses property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3344 + Return the value of the rules property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3345 + Return the value of the style property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3346 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3347 + Return the value of the summary property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3348 + Return the value of the title property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3349 + Return the value of the width property. + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3350 + + jakarta.faces.component.html + HtmlDataTable + + + + + JSF:JAVADOC:3351 + Set the value of the bgcolor property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3352 + Set the value of the bodyrows property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3353 + Set the value of the border property. + jakarta.faces.component.html + HtmlDataTable + + + int + + + + + + JSF:JAVADOC:3354 + Set the value of the captionClass property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3355 + Set the value of the captionStyle property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3356 + Set the value of the cellpadding property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3357 + Set the value of the cellspacing property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3358 + Set the value of the columnClasses property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3359 + Set the value of the dir property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3360 + Set the value of the footerClass property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3361 + Set the value of the frame property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3362 + Set the value of the headerClass property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3363 + Set the value of the lang property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3364 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3365 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3366 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3367 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3368 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3369 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3370 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3371 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3372 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3373 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3374 + Set the value of the role property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3375 + Set the value of the rowClass property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3376 + Set the value of the rowClasses property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3377 + Set the value of the rules property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3378 + Set the value of the style property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3379 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3380 + Set the value of the summary property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3381 + Set the value of the title property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3382 + Set the value of the width property. + jakarta.faces.component.html + HtmlDataTable + + + java.lang.String + + + + + + JSF:JAVADOC:3383 + + jakarta.faces.component.html + HtmlDataTable.PropertyKeys + + + + + JSF:JAVADOC:3384 + + jakarta.faces.component.html + HtmlDataTable.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3385 + + jakarta.faces.component.html + HtmlDataTable.PropertyKeys + + + + + JSF:JAVADOC:3386 + Return the value of the public property. + jakarta.faces.component.html + HtmlDoctype + + + + + JSF:JAVADOC:3387 + Return the value of the rootElement property. + jakarta.faces.component.html + HtmlDoctype + + + + + JSF:JAVADOC:3388 + Return the value of the system property. + jakarta.faces.component.html + HtmlDoctype + + + + + JSF:JAVADOC:3389 + + jakarta.faces.component.html + HtmlDoctype + + + + + JSF:JAVADOC:3390 + Set the value of the public property. + jakarta.faces.component.html + HtmlDoctype + + + java.lang.String + + + + + + JSF:JAVADOC:3391 + Set the value of the rootElement property. + jakarta.faces.component.html + HtmlDoctype + + + java.lang.String + + + + + + JSF:JAVADOC:3392 + Set the value of the system property. + jakarta.faces.component.html + HtmlDoctype + + + java.lang.String + + + + + + JSF:JAVADOC:3393 + + jakarta.faces.component.html + HtmlDoctype.PropertyKeys + + + + + JSF:JAVADOC:3394 + + jakarta.faces.component.html + HtmlDoctype.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3395 + + jakarta.faces.component.html + HtmlDoctype.PropertyKeys + + + + + JSF:JAVADOC:3396 + Return the value of the accept property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3397 + Return the value of the acceptcharset property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3398 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3399 + Return the value of the dir property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3400 + Return the value of the enctype property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3401 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3402 + Return the value of the lang property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3403 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3404 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3405 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3406 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3407 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3408 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3409 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3410 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3411 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3412 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3413 + Return the value of the onreset property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3414 + Return the value of the onsubmit property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3415 + Return the value of the role property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3416 + Return the value of the style property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3417 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3418 + Return the value of the target property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3419 + Return the value of the title property. + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3420 + + jakarta.faces.component.html + HtmlForm + + + + + JSF:JAVADOC:3421 + Set the value of the accept property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3422 + Set the value of the acceptcharset property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3423 + Set the value of the dir property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3424 + Set the value of the enctype property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3425 + Set the value of the lang property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3426 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3427 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3428 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3429 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3430 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3431 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3432 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3433 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3434 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3435 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3436 + Set the value of the onreset property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3437 + Set the value of the onsubmit property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3438 + Set the value of the role property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3439 + Set the value of the style property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3440 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3441 + Set the value of the target property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3442 + Set the value of the title property. + jakarta.faces.component.html + HtmlForm + + + java.lang.String + + + + + + JSF:JAVADOC:3443 + + jakarta.faces.component.html + HtmlForm.PropertyKeys + + + + + JSF:JAVADOC:3444 + + jakarta.faces.component.html + HtmlForm.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3445 + + jakarta.faces.component.html + HtmlForm.PropertyKeys + + + + + JSF:JAVADOC:3446 + Return the value of the alt property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3447 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3448 + Return the value of the dir property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3449 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3450 + Return the value of the height property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3451 + Return the value of the lang property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3452 + Return the value of the longdesc property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3453 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3454 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3455 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3456 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3457 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3458 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3459 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3460 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3461 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3462 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3463 + Return the value of the role property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3464 + Return the value of the style property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3465 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3466 + Return the value of the title property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3467 + Return the value of the usemap property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3468 + Return the value of the width property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3469 + + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3470 + Return the value of the ismap property. + jakarta.faces.component.html + HtmlGraphicImage + + + + + JSF:JAVADOC:3471 + Set the value of the alt property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3472 + Set the value of the dir property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3473 + Set the value of the height property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3474 + Set the value of the ismap property. + jakarta.faces.component.html + HtmlGraphicImage + + + boolean + + + + + + JSF:JAVADOC:3475 + Set the value of the lang property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3476 + Set the value of the longdesc property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3477 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3478 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3479 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3480 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3481 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3482 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3483 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3484 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3485 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3486 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3487 + Set the value of the role property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3488 + Set the value of the style property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3489 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3490 + Set the value of the title property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3491 + Set the value of the usemap property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3492 + Set the value of the width property. + jakarta.faces.component.html + HtmlGraphicImage + + + java.lang.String + + + + + + JSF:JAVADOC:3493 + + jakarta.faces.component.html + HtmlGraphicImage.PropertyKeys + + + + + JSF:JAVADOC:3494 + + jakarta.faces.component.html + HtmlGraphicImage.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3495 + + jakarta.faces.component.html + HtmlGraphicImage.PropertyKeys + + + + + JSF:JAVADOC:3496 + Return the value of the dir property. + jakarta.faces.component.html + HtmlHead + + + + + JSF:JAVADOC:3497 + Return the value of the lang property. + jakarta.faces.component.html + HtmlHead + + + + + JSF:JAVADOC:3498 + Return the value of the xmlns property. + jakarta.faces.component.html + HtmlHead + + + + + JSF:JAVADOC:3499 + + jakarta.faces.component.html + HtmlHead + + + + + JSF:JAVADOC:3500 + Set the value of the dir property. + jakarta.faces.component.html + HtmlHead + + + java.lang.String + + + + + + JSF:JAVADOC:3501 + Set the value of the lang property. + jakarta.faces.component.html + HtmlHead + + + java.lang.String + + + + + + JSF:JAVADOC:3502 + Set the value of the xmlns property. + jakarta.faces.component.html + HtmlHead + + + java.lang.String + + + + + + JSF:JAVADOC:3503 + + jakarta.faces.component.html + HtmlHead.PropertyKeys + + + + + JSF:JAVADOC:3504 + + jakarta.faces.component.html + HtmlHead.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3505 + + jakarta.faces.component.html + HtmlHead.PropertyKeys + + + + + JSF:JAVADOC:3506 + Return the value of the accept property. Contents: Comma separated string of mime types of files to filter in client side file browse dialog. Note: This is not validated in server side. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3507 + Return the value of the accesskey property. Contents: Access key that, when pressed, transfers focus to this element. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3508 + Return the value of the alt property. Contents: Alternate textual description of the element rendered by this component. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3509 + Return the value of the autocomplete property. Contents: If the value of this attribute is "off", render "off" as the value of the attribute. This indicates that the browser should disable its autocomplete feature for this component. This is useful for components that perform autocompletion and do not want the browser interfering. If this attribute is not set or the value is "on", render nothing. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3510 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3511 + Return the value of the dir property. Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). These attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct case. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3512 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3513 + Return the value of the label property. Contents: A localized user presentable name for this component. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3514 + Return the value of the lang property. Contents: Code describing the language used in the generated markup for this component. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3515 + Return the value of the maxlength property. Contents: The maximum number of characters that may be entered in this field. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3516 + Return the value of the onblur property. Contents: JavaScript code executed when this element loses focus. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3517 + Return the value of the onchange property. Contents: JavaScript code executed when this element loses focus and its value has been modified since gaining focus. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3518 + Return the value of the onclick property. Contents: JavaScript code executed when a pointer button is clicked over this element. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3519 + Return the value of the ondblclick property. Contents: JavaScript code executed when a pointer button is double clicked over this element. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3520 + Return the value of the onfocus property. Contents: JavaScript code executed when this element receives focus. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3521 + Return the value of the onkeydown property. Contents: JavaScript code executed when a key is pressed down over this element. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3522 + Return the value of the onkeypress property. Contents: JavaScript code executed when a key is pressed and released over this element. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3523 + Return the value of the onkeyup property. Contents: JavaScript code executed when a key is released over this element. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3524 + Return the value of the onmousedown property. Contents: JavaScript code executed when a pointer button is pressed down over this element. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3525 + Return the value of the onmousemove property. Contents: JavaScript code executed when a pointer button is moved within this element. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3526 + Return the value of the onmouseout property. Contents: JavaScript code executed when a pointer button is moved away from this element. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3527 + Return the value of the onmouseover property. Contents: JavaScript code executed when a pointer button is moved onto this element. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3528 + Return the value of the onmouseup property. Contents: JavaScript code executed when a pointer button is released over this element. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3529 + Return the value of the onselect property. Contents: JavaScript code executed when text within this element is selected by the user. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3530 + Return the value of the role property. Contents: Per the WAI-ARIA spec and its relationship to HTML5 (Section title ARIA Role Attriubute), every HTML element may have a "role" attribute whose value must be passed through unmodified on the element on which it is declared in the final rendered markup. The attribute, if specified, must have a value that is a string literal that is, or a Jakarta Expression Language Expression that evaluates to, a set of space-separated tokens representing the various WAI-ARIA roles that the element belongs to. It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3531 + Return the value of the size property. Contents: The number of characters used to determine the width of this field. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3532 + Return the value of the style property. Contents: CSS style(s) to be applied when this component is rendered. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3533 + Return the value of the styleClass property. Contents: Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3534 + Return the value of the tabindex property. Contents: Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3535 + Return the value of the title property. Contents: Advisory title information about markup elements generated for this component. + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3536 + + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3537 + Return the value of the disabled property. Contents: Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled". + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3538 + Return the value of the multiple property. Contents: Flag indicating that this element must allow multiple file selection. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as multiple="multiple". + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3539 + Return the value of the readonly property. Contents: Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly". + jakarta.faces.component.html + HtmlInputFile + + + + + JSF:JAVADOC:3540 + + jakarta.faces.component.html + HtmlInputFile + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:3541 + Set the value of the accept property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3542 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3543 + Set the value of the alt property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3544 + Set the value of the autocomplete property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3545 + Set the value of the dir property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3546 + Set the value of the disabled property. + jakarta.faces.component.html + HtmlInputFile + + + boolean + + + + + + JSF:JAVADOC:3547 + Set the value of the label property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3548 + Set the value of the lang property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3549 + Set the value of the maxlength property. + jakarta.faces.component.html + HtmlInputFile + + + int + + + + + + JSF:JAVADOC:3550 + Set the value of the multiple property. + jakarta.faces.component.html + HtmlInputFile + + + boolean + + + + + + JSF:JAVADOC:3551 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3552 + Set the value of the onchange property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3553 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3554 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3555 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3556 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3557 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3558 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3559 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3560 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3561 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3562 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3563 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3564 + Set the value of the onselect property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3565 + Set the value of the readonly property. + jakarta.faces.component.html + HtmlInputFile + + + boolean + + + + + + JSF:JAVADOC:3566 + Set the value of the role property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3567 + Set the value of the size property. + jakarta.faces.component.html + HtmlInputFile + + + int + + + + + + JSF:JAVADOC:3568 + Set the value of the style property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3569 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3570 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3571 + Set the value of the title property. + jakarta.faces.component.html + HtmlInputFile + + + java.lang.String + + + + + + JSF:JAVADOC:3572 + + jakarta.faces.component.html + HtmlInputFile.PropertyKeys + + + + + JSF:JAVADOC:3573 + + jakarta.faces.component.html + HtmlInputFile.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3574 + + jakarta.faces.component.html + HtmlInputFile.PropertyKeys + + + + + JSF:JAVADOC:3575 + + jakarta.faces.component.html + HtmlInputHidden + + + + + JSF:JAVADOC:3576 + + jakarta.faces.component.html + HtmlInputHidden.PropertyKeys + + + + + JSF:JAVADOC:3577 + + jakarta.faces.component.html + HtmlInputHidden.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3578 + + jakarta.faces.component.html + HtmlInputHidden.PropertyKeys + + + + + JSF:JAVADOC:3579 + Return the value of the accesskey property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3580 + Return the value of the alt property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3581 + Return the value of the autocomplete property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3582 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3583 + Return the value of the dir property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3584 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3585 + Return the value of the label property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3586 + Return the value of the lang property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3587 + Return the value of the maxlength property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3588 + Return the value of the onblur property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3589 + Return the value of the onchange property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3590 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3591 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3592 + Return the value of the onfocus property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3593 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3594 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3595 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3596 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3597 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3598 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3599 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3600 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3601 + Return the value of the onselect property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3602 + Return the value of the role property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3603 + Return the value of the size property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3604 + Return the value of the style property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3605 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3606 + Return the value of the tabindex property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3607 + Return the value of the title property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3608 + + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3609 + Return the value of the disabled property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3610 + Return the value of the readonly property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3611 + Return the value of the redisplay property. + jakarta.faces.component.html + HtmlInputSecret + + + + + JSF:JAVADOC:3612 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3613 + Set the value of the alt property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3614 + Set the value of the autocomplete property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3615 + Set the value of the dir property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3616 + Set the value of the disabled property. + jakarta.faces.component.html + HtmlInputSecret + + + boolean + + + + + + JSF:JAVADOC:3617 + Set the value of the label property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3618 + Set the value of the lang property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3619 + Set the value of the maxlength property. + jakarta.faces.component.html + HtmlInputSecret + + + int + + + + + + JSF:JAVADOC:3620 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3621 + Set the value of the onchange property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3622 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3623 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3624 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3625 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3626 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3627 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3628 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3629 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3630 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3631 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3632 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3633 + Set the value of the onselect property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3634 + Set the value of the readonly property. + jakarta.faces.component.html + HtmlInputSecret + + + boolean + + + + + + JSF:JAVADOC:3635 + Set the value of the redisplay property. + jakarta.faces.component.html + HtmlInputSecret + + + boolean + + + + + + JSF:JAVADOC:3636 + Set the value of the role property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3637 + Set the value of the size property. + jakarta.faces.component.html + HtmlInputSecret + + + int + + + + + + JSF:JAVADOC:3638 + Set the value of the style property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3639 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3640 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3641 + Set the value of the title property. + jakarta.faces.component.html + HtmlInputSecret + + + java.lang.String + + + + + + JSF:JAVADOC:3642 + + jakarta.faces.component.html + HtmlInputSecret.PropertyKeys + + + + + JSF:JAVADOC:3643 + + jakarta.faces.component.html + HtmlInputSecret.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3644 + + jakarta.faces.component.html + HtmlInputSecret.PropertyKeys + + + + + JSF:JAVADOC:3645 + Return the value of the accesskey property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3646 + Return the value of the alt property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3647 + Return the value of the autocomplete property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3648 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3649 + Return the value of the dir property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3650 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3651 + Return the value of the label property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3652 + Return the value of the lang property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3653 + Return the value of the maxlength property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3654 + Return the value of the onblur property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3655 + Return the value of the onchange property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3656 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3657 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3658 + Return the value of the onfocus property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3659 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3660 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3661 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3662 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3663 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3664 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3665 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3666 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3667 + Return the value of the onselect property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3668 + Return the value of the role property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3669 + Return the value of the size property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3670 + Return the value of the style property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3671 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3672 + Return the value of the tabindex property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3673 + Return the value of the title property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3674 + Return the value of the type property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3675 + + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3676 + Return the value of the disabled property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3677 + Return the value of the readonly property. + jakarta.faces.component.html + HtmlInputText + + + + + JSF:JAVADOC:3678 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3679 + Set the value of the alt property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3680 + Set the value of the autocomplete property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3681 + Set the value of the dir property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3682 + Set the value of the disabled property. + jakarta.faces.component.html + HtmlInputText + + + boolean + + + + + + JSF:JAVADOC:3683 + Set the value of the label property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3684 + Set the value of the lang property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3685 + Set the value of the maxlength property. + jakarta.faces.component.html + HtmlInputText + + + int + + + + + + JSF:JAVADOC:3686 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3687 + Set the value of the onchange property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3688 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3689 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3690 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3691 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3692 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3693 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3694 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3695 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3696 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3697 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3698 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3699 + Set the value of the onselect property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3700 + Set the value of the readonly property. + jakarta.faces.component.html + HtmlInputText + + + boolean + + + + + + JSF:JAVADOC:3701 + Set the value of the role property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3702 + Set the value of the size property. + jakarta.faces.component.html + HtmlInputText + + + int + + + + + + JSF:JAVADOC:3703 + Set the value of the style property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3704 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3705 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3706 + Set the value of the title property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3707 + Set the value of the type property. + jakarta.faces.component.html + HtmlInputText + + + java.lang.String + + + + + + JSF:JAVADOC:3708 + + jakarta.faces.component.html + HtmlInputText.PropertyKeys + + + + + JSF:JAVADOC:3709 + + jakarta.faces.component.html + HtmlInputText.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3710 + + jakarta.faces.component.html + HtmlInputText.PropertyKeys + + + + + JSF:JAVADOC:3711 + Return the value of the accesskey property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3712 + Return the value of the cols property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3713 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3714 + Return the value of the dir property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3715 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3716 + Return the value of the label property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3717 + Return the value of the lang property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3718 + Return the value of the onblur property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3719 + Return the value of the onchange property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3720 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3721 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3722 + Return the value of the onfocus property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3723 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3724 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3725 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3726 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3727 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3728 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3729 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3730 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3731 + Return the value of the onselect property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3732 + Return the value of the role property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3733 + Return the value of the rows property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3734 + Return the value of the style property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3735 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3736 + Return the value of the tabindex property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3737 + Return the value of the title property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3738 + + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3739 + Return the value of the disabled property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3740 + Return the value of the readonly property. + jakarta.faces.component.html + HtmlInputTextarea + + + + + JSF:JAVADOC:3741 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3742 + Set the value of the cols property. + jakarta.faces.component.html + HtmlInputTextarea + + + int + + + + + + JSF:JAVADOC:3743 + Set the value of the dir property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3744 + Set the value of the disabled property. + jakarta.faces.component.html + HtmlInputTextarea + + + boolean + + + + + + JSF:JAVADOC:3745 + Set the value of the label property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3746 + Set the value of the lang property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3747 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3748 + Set the value of the onchange property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3749 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3750 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3751 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3752 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3753 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3754 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3755 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3756 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3757 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3758 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3759 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3760 + Set the value of the onselect property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3761 + Set the value of the readonly property. + jakarta.faces.component.html + HtmlInputTextarea + + + boolean + + + + + + JSF:JAVADOC:3762 + Set the value of the role property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3763 + Set the value of the rows property. + jakarta.faces.component.html + HtmlInputTextarea + + + int + + + + + + JSF:JAVADOC:3764 + Set the value of the style property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3765 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3766 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3767 + Set the value of the title property. + jakarta.faces.component.html + HtmlInputTextarea + + + java.lang.String + + + + + + JSF:JAVADOC:3768 + + jakarta.faces.component.html + HtmlInputTextarea.PropertyKeys + + + + + JSF:JAVADOC:3769 + + jakarta.faces.component.html + HtmlInputTextarea.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3770 + + jakarta.faces.component.html + HtmlInputTextarea.PropertyKeys + + + + + JSF:JAVADOC:3771 + Return the value of the dir property. + jakarta.faces.component.html + HtmlMessage + + + + + JSF:JAVADOC:3772 + Return the value of the errorClass property. + jakarta.faces.component.html + HtmlMessage + + + + + JSF:JAVADOC:3773 + Return the value of the errorStyle property. + jakarta.faces.component.html + HtmlMessage + + + + + JSF:JAVADOC:3774 + Return the value of the fatalClass property. + jakarta.faces.component.html + HtmlMessage + + + + + JSF:JAVADOC:3775 + Return the value of the fatalStyle property. + jakarta.faces.component.html + HtmlMessage + + + + + JSF:JAVADOC:3776 + Return the value of the infoClass property. + jakarta.faces.component.html + HtmlMessage + + + + + JSF:JAVADOC:3777 + Return the value of the infoStyle property. + jakarta.faces.component.html + HtmlMessage + + + + + JSF:JAVADOC:3778 + Return the value of the lang property. + jakarta.faces.component.html + HtmlMessage + + + + + JSF:JAVADOC:3779 + Return the value of the role property. + jakarta.faces.component.html + HtmlMessage + + + + + JSF:JAVADOC:3780 + Return the value of the style property. + jakarta.faces.component.html + HtmlMessage + + + + + JSF:JAVADOC:3781 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlMessage + + + + + JSF:JAVADOC:3782 + Return the value of the title property. + jakarta.faces.component.html + HtmlMessage + + + + + JSF:JAVADOC:3783 + Return the value of the warnClass property. + jakarta.faces.component.html + HtmlMessage + + + + + JSF:JAVADOC:3784 + Return the value of the warnStyle property. + jakarta.faces.component.html + HtmlMessage + + + + + JSF:JAVADOC:3785 + + jakarta.faces.component.html + HtmlMessage + + + + + JSF:JAVADOC:3786 + Return the value of the tooltip property. + jakarta.faces.component.html + HtmlMessage + + + + + JSF:JAVADOC:3787 + Set the value of the dir property. + jakarta.faces.component.html + HtmlMessage + + + java.lang.String + + + + + + JSF:JAVADOC:3788 + Set the value of the errorClass property. + jakarta.faces.component.html + HtmlMessage + + + java.lang.String + + + + + + JSF:JAVADOC:3789 + Set the value of the errorStyle property. + jakarta.faces.component.html + HtmlMessage + + + java.lang.String + + + + + + JSF:JAVADOC:3790 + Set the value of the fatalClass property. + jakarta.faces.component.html + HtmlMessage + + + java.lang.String + + + + + + JSF:JAVADOC:3791 + Set the value of the fatalStyle property. + jakarta.faces.component.html + HtmlMessage + + + java.lang.String + + + + + + JSF:JAVADOC:3792 + Set the value of the infoClass property. + jakarta.faces.component.html + HtmlMessage + + + java.lang.String + + + + + + JSF:JAVADOC:3793 + Set the value of the infoStyle property. + jakarta.faces.component.html + HtmlMessage + + + java.lang.String + + + + + + JSF:JAVADOC:3794 + Set the value of the lang property. + jakarta.faces.component.html + HtmlMessage + + + java.lang.String + + + + + + JSF:JAVADOC:3795 + Set the value of the role property. + jakarta.faces.component.html + HtmlMessage + + + java.lang.String + + + + + + JSF:JAVADOC:3796 + Set the value of the style property. + jakarta.faces.component.html + HtmlMessage + + + java.lang.String + + + + + + JSF:JAVADOC:3797 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlMessage + + + java.lang.String + + + + + + JSF:JAVADOC:3798 + Set the value of the title property. + jakarta.faces.component.html + HtmlMessage + + + java.lang.String + + + + + + JSF:JAVADOC:3799 + Set the value of the tooltip property. + jakarta.faces.component.html + HtmlMessage + + + boolean + + + + + + JSF:JAVADOC:3800 + Set the value of the warnClass property. + jakarta.faces.component.html + HtmlMessage + + + java.lang.String + + + + + + JSF:JAVADOC:3801 + Set the value of the warnStyle property. + jakarta.faces.component.html + HtmlMessage + + + java.lang.String + + + + + + JSF:JAVADOC:3802 + + jakarta.faces.component.html + HtmlMessage.PropertyKeys + + + + + JSF:JAVADOC:3803 + + jakarta.faces.component.html + HtmlMessage.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3804 + + jakarta.faces.component.html + HtmlMessage.PropertyKeys + + + + + JSF:JAVADOC:3805 + Return the value of the dir property. + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3806 + Return the value of the errorClass property. + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3807 + Return the value of the errorStyle property. + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3808 + Return the value of the fatalClass property. + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3809 + Return the value of the fatalStyle property. + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3810 + Return the value of the infoClass property. + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3811 + Return the value of the infoStyle property. + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3812 + Return the value of the lang property. + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3813 + Return the value of the layout property. + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3814 + Return the value of the role property. + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3815 + Return the value of the style property. + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3816 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3817 + Return the value of the title property. + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3818 + Return the value of the warnClass property. + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3819 + Return the value of the warnStyle property. + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3820 + + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3821 + Return the value of the tooltip property. + jakarta.faces.component.html + HtmlMessages + + + + + JSF:JAVADOC:3822 + Set the value of the dir property. + jakarta.faces.component.html + HtmlMessages + + + java.lang.String + + + + + + JSF:JAVADOC:3823 + Set the value of the errorClass property. + jakarta.faces.component.html + HtmlMessages + + + java.lang.String + + + + + + JSF:JAVADOC:3824 + Set the value of the errorStyle property. + jakarta.faces.component.html + HtmlMessages + + + java.lang.String + + + + + + JSF:JAVADOC:3825 + Set the value of the fatalClass property. + jakarta.faces.component.html + HtmlMessages + + + java.lang.String + + + + + + JSF:JAVADOC:3826 + Set the value of the fatalStyle property. + jakarta.faces.component.html + HtmlMessages + + + java.lang.String + + + + + + JSF:JAVADOC:3827 + Set the value of the infoClass property. + jakarta.faces.component.html + HtmlMessages + + + java.lang.String + + + + + + JSF:JAVADOC:3828 + Set the value of the infoStyle property. + jakarta.faces.component.html + HtmlMessages + + + java.lang.String + + + + + + JSF:JAVADOC:3829 + Set the value of the lang property. + jakarta.faces.component.html + HtmlMessages + + + java.lang.String + + + + + + JSF:JAVADOC:3830 + Set the value of the layout property. + jakarta.faces.component.html + HtmlMessages + + + java.lang.String + + + + + + JSF:JAVADOC:3831 + Set the value of the role property. + jakarta.faces.component.html + HtmlMessages + + + java.lang.String + + + + + + JSF:JAVADOC:3832 + Set the value of the style property. + jakarta.faces.component.html + HtmlMessages + + + java.lang.String + + + + + + JSF:JAVADOC:3833 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlMessages + + + java.lang.String + + + + + + JSF:JAVADOC:3834 + Set the value of the title property. + jakarta.faces.component.html + HtmlMessages + + + java.lang.String + + + + + + JSF:JAVADOC:3835 + Set the value of the tooltip property. + jakarta.faces.component.html + HtmlMessages + + + boolean + + + + + + JSF:JAVADOC:3836 + Set the value of the warnClass property. + jakarta.faces.component.html + HtmlMessages + + + java.lang.String + + + + + + JSF:JAVADOC:3837 + Set the value of the warnStyle property. + jakarta.faces.component.html + HtmlMessages + + + java.lang.String + + + + + + JSF:JAVADOC:3838 + + jakarta.faces.component.html + HtmlMessages.PropertyKeys + + + + + JSF:JAVADOC:3839 + + jakarta.faces.component.html + HtmlMessages.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3840 + + jakarta.faces.component.html + HtmlMessages.PropertyKeys + + + + + JSF:JAVADOC:3841 + Return the value of the accesskey property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3842 + Return the value of the alt property. This attribute is ignored when the image attribute is not specified. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3843 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3844 + Return the value of the dir property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3845 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3846 + Return the value of the image property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3847 + Return the value of the lang property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3848 + Return the value of the onblur property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3849 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3850 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3851 + Return the value of the onfocus property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3852 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3853 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3854 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3855 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3856 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3857 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3858 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3859 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3860 + Return the value of the role property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3861 + Return the value of the style property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3862 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3863 + Return the value of the tabindex property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3864 + Return the value of the title property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3865 + + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3866 + Return the value of the disabled property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + + + JSF:JAVADOC:3867 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3868 + Set the value of the alt property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3869 + Set the value of the dir property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3870 + Set the value of the disabled property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + boolean + + + + + + JSF:JAVADOC:3871 + Set the value of the image property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3872 + Set the value of the lang property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3873 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3874 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3875 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3876 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3877 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3878 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3879 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3880 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3881 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3882 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3883 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3884 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3885 + Set the value of the role property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3886 + Set the value of the style property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3887 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3888 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3889 + Set the value of the title property. + jakarta.faces.component.html + HtmlOutcomeTargetButton + + + java.lang.String + + + + + + JSF:JAVADOC:3890 + + jakarta.faces.component.html + HtmlOutcomeTargetButton.PropertyKeys + + + + + JSF:JAVADOC:3891 + + jakarta.faces.component.html + HtmlOutcomeTargetButton.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3892 + + jakarta.faces.component.html + HtmlOutcomeTargetButton.PropertyKeys + + + + + JSF:JAVADOC:3893 + Return the value of the accesskey property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3894 + Return the value of the charset property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3895 + Return the value of the coords property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3896 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3897 + Return the value of the dir property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3898 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3899 + Return the value of the hreflang property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3900 + Return the value of the lang property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3901 + Return the value of the onblur property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3902 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3903 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3904 + Return the value of the onfocus property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3905 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3906 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3907 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3908 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3909 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3910 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3911 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3912 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3913 + Return the value of the rel property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3914 + Return the value of the rev property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3915 + Return the value of the role property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3916 + Return the value of the shape property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3917 + Return the value of the style property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3918 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3919 + Return the value of the tabindex property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3920 + Return the value of the target property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3921 + Return the value of the title property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3922 + Return the value of the type property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3923 + + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3924 + Return the value of the disabled property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + + + JSF:JAVADOC:3925 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3926 + Set the value of the charset property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3927 + Set the value of the coords property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3928 + Set the value of the dir property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3929 + Set the value of the disabled property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + boolean + + + + + + JSF:JAVADOC:3930 + Set the value of the hreflang property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3931 + Set the value of the lang property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3932 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3933 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3934 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3935 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3936 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3937 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3938 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3939 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3940 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3941 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3942 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3943 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3944 + Set the value of the rel property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3945 + Set the value of the rev property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3946 + Set the value of the role property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3947 + Set the value of the shape property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3948 + Set the value of the style property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3949 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3950 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3951 + Set the value of the target property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3952 + Set the value of the title property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3953 + Set the value of the type property. + jakarta.faces.component.html + HtmlOutcomeTargetLink + + + java.lang.String + + + + + + JSF:JAVADOC:3954 + + jakarta.faces.component.html + HtmlOutcomeTargetLink.PropertyKeys + + + + + JSF:JAVADOC:3955 + + jakarta.faces.component.html + HtmlOutcomeTargetLink.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3956 + + jakarta.faces.component.html + HtmlOutcomeTargetLink.PropertyKeys + + + + + JSF:JAVADOC:3957 + Return the value of the dir property. + jakarta.faces.component.html + HtmlOutputFormat + + + + + JSF:JAVADOC:3958 + Return the value of the lang property. + jakarta.faces.component.html + HtmlOutputFormat + + + + + JSF:JAVADOC:3959 + Return the value of the role property. + jakarta.faces.component.html + HtmlOutputFormat + + + + + JSF:JAVADOC:3960 + Return the value of the style property. + jakarta.faces.component.html + HtmlOutputFormat + + + + + JSF:JAVADOC:3961 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlOutputFormat + + + + + JSF:JAVADOC:3962 + Return the value of the title property. + jakarta.faces.component.html + HtmlOutputFormat + + + + + JSF:JAVADOC:3963 + + jakarta.faces.component.html + HtmlOutputFormat + + + + + JSF:JAVADOC:3964 + Return the value of the escape property. + jakarta.faces.component.html + HtmlOutputFormat + + + + + JSF:JAVADOC:3965 + Set the value of the dir property. + jakarta.faces.component.html + HtmlOutputFormat + + + java.lang.String + + + + + + JSF:JAVADOC:3966 + Set the value of the escape property. + jakarta.faces.component.html + HtmlOutputFormat + + + boolean + + + + + + JSF:JAVADOC:3967 + Set the value of the lang property. + jakarta.faces.component.html + HtmlOutputFormat + + + java.lang.String + + + + + + JSF:JAVADOC:3968 + Set the value of the role property. + jakarta.faces.component.html + HtmlOutputFormat + + + java.lang.String + + + + + + JSF:JAVADOC:3969 + Set the value of the style property. + jakarta.faces.component.html + HtmlOutputFormat + + + java.lang.String + + + + + + JSF:JAVADOC:3970 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlOutputFormat + + + java.lang.String + + + + + + JSF:JAVADOC:3971 + Set the value of the title property. + jakarta.faces.component.html + HtmlOutputFormat + + + java.lang.String + + + + + + JSF:JAVADOC:3972 + + jakarta.faces.component.html + HtmlOutputFormat.PropertyKeys + + + + + JSF:JAVADOC:3973 + + jakarta.faces.component.html + HtmlOutputFormat.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:3974 + + jakarta.faces.component.html + HtmlOutputFormat.PropertyKeys + + + + + JSF:JAVADOC:3975 + Return the value of the accesskey property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3976 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3977 + Return the value of the dir property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3978 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3979 + Return the value of the for property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3980 + Return the value of the lang property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3981 + Return the value of the onblur property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3982 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3983 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3984 + Return the value of the onfocus property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3985 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3986 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3987 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3988 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3989 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3990 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3991 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3992 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3993 + Return the value of the role property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3994 + Return the value of the style property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3995 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3996 + Return the value of the tabindex property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3997 + Return the value of the title property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3998 + + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:3999 + Return the value of the escape property. + jakarta.faces.component.html + HtmlOutputLabel + + + + + JSF:JAVADOC:4000 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4001 + Set the value of the dir property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4002 + Set the value of the escape property. + jakarta.faces.component.html + HtmlOutputLabel + + + boolean + + + + + + JSF:JAVADOC:4003 + Set the value of the for property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4004 + Set the value of the lang property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4005 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4006 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4007 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4008 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4009 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4010 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4011 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4012 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4013 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4014 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4015 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4016 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4017 + Set the value of the role property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4018 + Set the value of the style property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4019 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4020 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4021 + Set the value of the title property. + jakarta.faces.component.html + HtmlOutputLabel + + + java.lang.String + + + + + + JSF:JAVADOC:4022 + + jakarta.faces.component.html + HtmlOutputLabel.PropertyKeys + + + + + JSF:JAVADOC:4023 + + jakarta.faces.component.html + HtmlOutputLabel.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:4024 + + jakarta.faces.component.html + HtmlOutputLabel.PropertyKeys + + + + + JSF:JAVADOC:4025 + Return the value of the accesskey property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4026 + Return the value of the charset property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4027 + Return the value of the coords property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4028 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4029 + Return the value of the dir property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4030 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4031 + Return the value of the fragment property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4032 + Return the value of the hreflang property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4033 + Return the value of the lang property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4034 + Return the value of the onblur property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4035 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4036 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4037 + Return the value of the onfocus property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4038 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4039 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4040 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4041 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4042 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4043 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4044 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4045 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4046 + Return the value of the rel property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4047 + Return the value of the rev property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4048 + Return the value of the role property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4049 + Return the value of the shape property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4050 + Return the value of the style property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4051 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4052 + Return the value of the tabindex property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4053 + Return the value of the target property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4054 + Return the value of the title property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4055 + Return the value of the type property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4056 + + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4057 + Return the value of the disabled property. + jakarta.faces.component.html + HtmlOutputLink + + + + + JSF:JAVADOC:4058 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4059 + Set the value of the charset property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4060 + Set the value of the coords property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4061 + Set the value of the dir property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4062 + Set the value of the disabled property. + jakarta.faces.component.html + HtmlOutputLink + + + boolean + + + + + + JSF:JAVADOC:4063 + Set the value of the fragment property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4064 + Set the value of the hreflang property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4065 + Set the value of the lang property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4066 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4067 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4068 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4069 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4070 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4071 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4072 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4073 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4074 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4075 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4076 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4077 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4078 + Set the value of the rel property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4079 + Set the value of the rev property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4080 + Set the value of the role property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4081 + Set the value of the shape property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4082 + Set the value of the style property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4083 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4084 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4085 + Set the value of the target property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4086 + Set the value of the title property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4087 + Set the value of the type property. + jakarta.faces.component.html + HtmlOutputLink + + + java.lang.String + + + + + + JSF:JAVADOC:4088 + + jakarta.faces.component.html + HtmlOutputLink.PropertyKeys + + + + + JSF:JAVADOC:4089 + + jakarta.faces.component.html + HtmlOutputLink.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:4090 + + jakarta.faces.component.html + HtmlOutputLink.PropertyKeys + + + + + JSF:JAVADOC:4091 + Return the value of the dir property. + jakarta.faces.component.html + HtmlOutputText + + + + + JSF:JAVADOC:4092 + Return the value of the lang property. + jakarta.faces.component.html + HtmlOutputText + + + + + JSF:JAVADOC:4093 + Return the value of the role property. + jakarta.faces.component.html + HtmlOutputText + + + + + JSF:JAVADOC:4094 + Return the value of the style property. + jakarta.faces.component.html + HtmlOutputText + + + + + JSF:JAVADOC:4095 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlOutputText + + + + + JSF:JAVADOC:4096 + Return the value of the title property. + jakarta.faces.component.html + HtmlOutputText + + + + + JSF:JAVADOC:4097 + + jakarta.faces.component.html + HtmlOutputText + + + + + JSF:JAVADOC:4098 + Return the value of the escape property. + jakarta.faces.component.html + HtmlOutputText + + + + + JSF:JAVADOC:4099 + Set the value of the dir property. + jakarta.faces.component.html + HtmlOutputText + + + java.lang.String + + + + + + JSF:JAVADOC:4100 + Set the value of the escape property. + jakarta.faces.component.html + HtmlOutputText + + + boolean + + + + + + JSF:JAVADOC:4101 + Set the value of the lang property. + jakarta.faces.component.html + HtmlOutputText + + + java.lang.String + + + + + + JSF:JAVADOC:4102 + Set the value of the role property. + jakarta.faces.component.html + HtmlOutputText + + + java.lang.String + + + + + + JSF:JAVADOC:4103 + Set the value of the style property. + jakarta.faces.component.html + HtmlOutputText + + + java.lang.String + + + + + + JSF:JAVADOC:4104 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlOutputText + + + java.lang.String + + + + + + JSF:JAVADOC:4105 + Set the value of the title property. + jakarta.faces.component.html + HtmlOutputText + + + java.lang.String + + + + + + JSF:JAVADOC:4106 + + jakarta.faces.component.html + HtmlOutputText.PropertyKeys + + + + + JSF:JAVADOC:4107 + + jakarta.faces.component.html + HtmlOutputText.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:4108 + + jakarta.faces.component.html + HtmlOutputText.PropertyKeys + + + + + JSF:JAVADOC:4109 + Return the value of the bgcolor property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4110 + Return the value of the bodyrows property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4111 + Return the value of the border property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4112 + Return the value of the captionClass property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4113 + Return the value of the captionStyle property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4114 + Return the value of the cellpadding property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4115 + Return the value of the cellspacing property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4116 + Return the value of the columnClasses property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4117 + Return the value of the columns property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4118 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4119 + Return the value of the dir property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4120 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4121 + Return the value of the footerClass property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4122 + Return the value of the frame property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4123 + Return the value of the headerClass property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4124 + Return the value of the lang property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4125 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4126 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4127 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4128 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4129 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4130 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4131 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4132 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4133 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4134 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4135 + Return the value of the role property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4136 + Return the value of the rowClass property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4137 + Return the value of the rowClasses property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4138 + Return the value of the rules property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4139 + Return the value of the style property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4140 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4141 + Return the value of the summary property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4142 + Return the value of the title property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4143 + Return the value of the width property. + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4144 + + jakarta.faces.component.html + HtmlPanelGrid + + + + + JSF:JAVADOC:4145 + Set the value of the bgcolor property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4146 + Set the value of the bodyrows property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4147 + Set the value of the border property. + jakarta.faces.component.html + HtmlPanelGrid + + + int + + + + + + JSF:JAVADOC:4148 + Set the value of the captionClass property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4149 + Set the value of the captionStyle property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4150 + Set the value of the cellpadding property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4151 + Set the value of the cellspacing property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4152 + Set the value of the columnClasses property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4153 + Set the value of the columns property. + jakarta.faces.component.html + HtmlPanelGrid + + + int + + + + + + JSF:JAVADOC:4154 + Set the value of the dir property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4155 + Set the value of the footerClass property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4156 + Set the value of the frame property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4157 + Set the value of the headerClass property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4158 + Set the value of the lang property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4159 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4160 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4161 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4162 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4163 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4164 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4165 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4166 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4167 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4168 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4169 + Set the value of the role property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4170 + Set the value of the rowClass property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4171 + Set the value of the rowClasses property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4172 + Set the value of the rules property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4173 + Set the value of the style property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4174 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4175 + Set the value of the summary property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4176 + Set the value of the title property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4177 + Set the value of the width property. + jakarta.faces.component.html + HtmlPanelGrid + + + java.lang.String + + + + + + JSF:JAVADOC:4178 + + jakarta.faces.component.html + HtmlPanelGrid.PropertyKeys + + + + + JSF:JAVADOC:4179 + + jakarta.faces.component.html + HtmlPanelGrid.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:4180 + + jakarta.faces.component.html + HtmlPanelGrid.PropertyKeys + + + + + JSF:JAVADOC:4181 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlPanelGroup + + + + + JSF:JAVADOC:4182 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlPanelGroup + + + + + JSF:JAVADOC:4183 + Return the value of the layout property. + jakarta.faces.component.html + HtmlPanelGroup + + + + + JSF:JAVADOC:4184 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlPanelGroup + + + + + JSF:JAVADOC:4185 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlPanelGroup + + + + + JSF:JAVADOC:4186 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlPanelGroup + + + + + JSF:JAVADOC:4187 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlPanelGroup + + + + + JSF:JAVADOC:4188 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlPanelGroup + + + + + JSF:JAVADOC:4189 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlPanelGroup + + + + + JSF:JAVADOC:4190 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlPanelGroup + + + + + JSF:JAVADOC:4191 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlPanelGroup + + + + + JSF:JAVADOC:4192 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlPanelGroup + + + + + JSF:JAVADOC:4193 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlPanelGroup + + + + + JSF:JAVADOC:4194 + Return the value of the style property. + jakarta.faces.component.html + HtmlPanelGroup + + + + + JSF:JAVADOC:4195 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlPanelGroup + + + + + JSF:JAVADOC:4196 + + jakarta.faces.component.html + HtmlPanelGroup + + + + + JSF:JAVADOC:4197 + Set the value of the layout property. + jakarta.faces.component.html + HtmlPanelGroup + + + java.lang.String + + + + + + JSF:JAVADOC:4198 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlPanelGroup + + + java.lang.String + + + + + + JSF:JAVADOC:4199 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlPanelGroup + + + java.lang.String + + + + + + JSF:JAVADOC:4200 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlPanelGroup + + + java.lang.String + + + + + + JSF:JAVADOC:4201 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlPanelGroup + + + java.lang.String + + + + + + JSF:JAVADOC:4202 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlPanelGroup + + + java.lang.String + + + + + + JSF:JAVADOC:4203 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlPanelGroup + + + java.lang.String + + + + + + JSF:JAVADOC:4204 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlPanelGroup + + + java.lang.String + + + + + + JSF:JAVADOC:4205 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlPanelGroup + + + java.lang.String + + + + + + JSF:JAVADOC:4206 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlPanelGroup + + + java.lang.String + + + + + + JSF:JAVADOC:4207 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlPanelGroup + + + java.lang.String + + + + + + JSF:JAVADOC:4208 + Set the value of the style property. + jakarta.faces.component.html + HtmlPanelGroup + + + java.lang.String + + + + + + JSF:JAVADOC:4209 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlPanelGroup + + + java.lang.String + + + + + + JSF:JAVADOC:4210 + + jakarta.faces.component.html + HtmlPanelGroup.PropertyKeys + + + + + JSF:JAVADOC:4211 + + jakarta.faces.component.html + HtmlPanelGroup.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:4212 + + jakarta.faces.component.html + HtmlPanelGroup.PropertyKeys + + + + + JSF:JAVADOC:4213 + Return the value of the accesskey property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4214 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4215 + Return the value of the dir property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4216 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4217 + Return the value of the label property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4218 + Return the value of the lang property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4219 + Return the value of the onblur property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4220 + Return the value of the onchange property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4221 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4222 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4223 + Return the value of the onfocus property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4224 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4225 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4226 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4227 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4228 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4229 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4230 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4231 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4232 + Return the value of the onselect property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4233 + Return the value of the role property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4234 + Return the value of the style property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4235 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4236 + Return the value of the tabindex property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4237 + Return the value of the title property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4238 + + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4239 + Return the value of the disabled property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4240 + Return the value of the readonly property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + + + JSF:JAVADOC:4241 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4242 + Set the value of the dir property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4243 + Set the value of the disabled property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + boolean + + + + + + JSF:JAVADOC:4244 + Set the value of the label property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4245 + Set the value of the lang property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4246 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4247 + Set the value of the onchange property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4248 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4249 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4250 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4251 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4252 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4253 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4254 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4255 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4256 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4257 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4258 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4259 + Set the value of the onselect property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4260 + Set the value of the readonly property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + boolean + + + + + + JSF:JAVADOC:4261 + Set the value of the role property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4262 + Set the value of the style property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4263 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4264 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4265 + Set the value of the title property. + jakarta.faces.component.html + HtmlSelectBooleanCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4266 + + jakarta.faces.component.html + HtmlSelectBooleanCheckbox.PropertyKeys + + + + + JSF:JAVADOC:4267 + + jakarta.faces.component.html + HtmlSelectBooleanCheckbox.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:4268 + + jakarta.faces.component.html + HtmlSelectBooleanCheckbox.PropertyKeys + + + + + JSF:JAVADOC:4269 + Return the value of the accesskey property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4270 + Return the value of the border property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4271 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4272 + Return the value of the dir property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4273 + Return the value of the disabledClass property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4274 + Return the value of the enabledClass property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4275 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4276 + Return the value of the label property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4277 + Return the value of the lang property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4278 + Return the value of the layout property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4279 + Return the value of the onblur property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4280 + Return the value of the onchange property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4281 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4282 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4283 + Return the value of the onfocus property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4284 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4285 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4286 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4287 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4288 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4289 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4290 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4291 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4292 + Return the value of the onselect property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4293 + Return the value of the role property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4294 + Return the value of the selectedClass property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4295 + Return the value of the style property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4296 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4297 + Return the value of the tabindex property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4298 + Return the value of the title property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4299 + Return the value of the unselectedClass property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4300 + + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4301 + Return the value of the disabled property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4302 + Return the value of the readonly property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + + + JSF:JAVADOC:4303 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4304 + Set the value of the border property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + int + + + + + + JSF:JAVADOC:4305 + Set the value of the dir property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4306 + Set the value of the disabled property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + boolean + + + + + + JSF:JAVADOC:4307 + Set the value of the disabledClass property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4308 + Set the value of the enabledClass property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4309 + Set the value of the label property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4310 + Set the value of the lang property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4311 + Set the value of the layout property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4312 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4313 + Set the value of the onchange property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4314 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4315 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4316 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4317 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4318 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4319 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4320 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4321 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4322 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4323 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4324 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4325 + Set the value of the onselect property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4326 + Set the value of the readonly property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + boolean + + + + + + JSF:JAVADOC:4327 + Set the value of the role property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4328 + Set the value of the selectedClass property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4329 + Set the value of the style property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4330 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4331 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4332 + Set the value of the title property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4333 + Set the value of the unselectedClass property. + jakarta.faces.component.html + HtmlSelectManyCheckbox + + + java.lang.String + + + + + + JSF:JAVADOC:4334 + + jakarta.faces.component.html + HtmlSelectManyCheckbox.PropertyKeys + + + + + JSF:JAVADOC:4335 + + jakarta.faces.component.html + HtmlSelectManyCheckbox.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:4336 + + jakarta.faces.component.html + HtmlSelectManyCheckbox.PropertyKeys + + + + + JSF:JAVADOC:4337 + Return the value of the accesskey property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4338 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4339 + Return the value of the dir property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4340 + Return the value of the disabledClass property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4341 + Return the value of the enabledClass property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4342 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4343 + Return the value of the label property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4344 + Return the value of the lang property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4345 + Return the value of the onblur property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4346 + Return the value of the onchange property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4347 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4348 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4349 + Return the value of the onfocus property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4350 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4351 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4352 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4353 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4354 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4355 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4356 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4357 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4358 + Return the value of the role property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4359 + Return the value of the size property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4360 + Return the value of the style property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4361 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4362 + Return the value of the tabindex property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4363 + Return the value of the title property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4364 + + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4365 + Return the value of the disabled property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4366 + Return the value of the readonly property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + + + JSF:JAVADOC:4367 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4368 + Set the value of the dir property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4369 + Set the value of the disabled property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + boolean + + + + + + JSF:JAVADOC:4370 + Set the value of the disabledClass property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4371 + Set the value of the enabledClass property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4372 + Set the value of the label property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4373 + Set the value of the lang property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4374 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4375 + Set the value of the onchange property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4376 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4377 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4378 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4379 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4380 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4381 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4382 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4383 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4384 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4385 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4386 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4387 + Set the value of the readonly property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + boolean + + + + + + JSF:JAVADOC:4388 + Set the value of the role property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4389 + Set the value of the size property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + int + + + + + + JSF:JAVADOC:4390 + Set the value of the style property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4391 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4392 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4393 + Set the value of the title property. + jakarta.faces.component.html + HtmlSelectManyListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4394 + + jakarta.faces.component.html + HtmlSelectManyListbox.PropertyKeys + + + + + JSF:JAVADOC:4395 + + jakarta.faces.component.html + HtmlSelectManyListbox.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:4396 + + jakarta.faces.component.html + HtmlSelectManyListbox.PropertyKeys + + + + + JSF:JAVADOC:4397 + Return the value of the accesskey property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4398 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4399 + Return the value of the dir property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4400 + Return the value of the disabledClass property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4401 + Return the value of the enabledClass property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4402 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4403 + Return the value of the label property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4404 + Return the value of the lang property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4405 + Return the value of the onblur property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4406 + Return the value of the onchange property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4407 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4408 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4409 + Return the value of the onfocus property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4410 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4411 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4412 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4413 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4414 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4415 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4416 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4417 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4418 + Return the value of the role property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4419 + Return the value of the style property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4420 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4421 + Return the value of the tabindex property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4422 + Return the value of the title property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4423 + + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4424 + Return the value of the disabled property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4425 + Return the value of the readonly property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + + + JSF:JAVADOC:4426 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4427 + Set the value of the dir property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4428 + Set the value of the disabled property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + boolean + + + + + + JSF:JAVADOC:4429 + Set the value of the disabledClass property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4430 + Set the value of the enabledClass property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4431 + Set the value of the label property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4432 + Set the value of the lang property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4433 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4434 + Set the value of the onchange property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4435 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4436 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4437 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4438 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4439 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4440 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4441 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4442 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4443 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4444 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4445 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4446 + Set the value of the readonly property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + boolean + + + + + + JSF:JAVADOC:4447 + Set the value of the role property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4448 + Set the value of the style property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4449 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4450 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4451 + Set the value of the title property. + jakarta.faces.component.html + HtmlSelectManyMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4452 + + jakarta.faces.component.html + HtmlSelectManyMenu.PropertyKeys + + + + + JSF:JAVADOC:4453 + + jakarta.faces.component.html + HtmlSelectManyMenu.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:4454 + + jakarta.faces.component.html + HtmlSelectManyMenu.PropertyKeys + + + + + JSF:JAVADOC:4455 + Return the value of the accesskey property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4456 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4457 + Return the value of the dir property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4458 + Return the value of the disabledClass property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4459 + Return the value of the enabledClass property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4460 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4461 + Return the value of the label property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4462 + Return the value of the lang property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4463 + Return the value of the onblur property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4464 + Return the value of the onchange property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4465 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4466 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4467 + Return the value of the onfocus property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4468 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4469 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4470 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4471 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4472 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4473 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4474 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4475 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4476 + Return the value of the role property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4477 + Return the value of the size property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4478 + Return the value of the style property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4479 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4480 + Return the value of the tabindex property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4481 + Return the value of the title property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4482 + + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4483 + Return the value of the disabled property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4484 + Return the value of the readonly property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + + + JSF:JAVADOC:4485 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4486 + Set the value of the dir property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4487 + Set the value of the disabled property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + boolean + + + + + + JSF:JAVADOC:4488 + Set the value of the disabledClass property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4489 + Set the value of the enabledClass property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4490 + Set the value of the label property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4491 + Set the value of the lang property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4492 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4493 + Set the value of the onchange property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4494 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4495 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4496 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4497 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4498 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4499 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4500 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4501 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4502 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4503 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4504 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4505 + Set the value of the readonly property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + boolean + + + + + + JSF:JAVADOC:4506 + Set the value of the role property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4507 + Set the value of the size property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + int + + + + + + JSF:JAVADOC:4508 + Set the value of the style property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4509 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4510 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4511 + Set the value of the title property. + jakarta.faces.component.html + HtmlSelectOneListbox + + + java.lang.String + + + + + + JSF:JAVADOC:4512 + + jakarta.faces.component.html + HtmlSelectOneListbox.PropertyKeys + + + + + JSF:JAVADOC:4513 + + jakarta.faces.component.html + HtmlSelectOneListbox.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:4514 + + jakarta.faces.component.html + HtmlSelectOneListbox.PropertyKeys + + + + + JSF:JAVADOC:4515 + Return the value of the accesskey property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4516 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4517 + Return the value of the dir property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4518 + Return the value of the disabledClass property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4519 + Return the value of the enabledClass property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4520 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4521 + Return the value of the label property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4522 + Return the value of the lang property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4523 + Return the value of the onblur property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4524 + Return the value of the onchange property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4525 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4526 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4527 + Return the value of the onfocus property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4528 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4529 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4530 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4531 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4532 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4533 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4534 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4535 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4536 + Return the value of the role property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4537 + Return the value of the style property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4538 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4539 + Return the value of the tabindex property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4540 + Return the value of the title property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4541 + + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4542 + Return the value of the disabled property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4543 + Return the value of the readonly property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + + + JSF:JAVADOC:4544 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4545 + Set the value of the dir property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4546 + Set the value of the disabled property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + boolean + + + + + + JSF:JAVADOC:4547 + Set the value of the disabledClass property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4548 + Set the value of the enabledClass property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4549 + Set the value of the label property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4550 + Set the value of the lang property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4551 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4552 + Set the value of the onchange property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4553 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4554 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4555 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4556 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4557 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4558 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4559 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4560 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4561 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4562 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4563 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4564 + Set the value of the readonly property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + boolean + + + + + + JSF:JAVADOC:4565 + Set the value of the role property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4566 + Set the value of the style property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4567 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4568 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4569 + Set the value of the title property. + jakarta.faces.component.html + HtmlSelectOneMenu + + + java.lang.String + + + + + + JSF:JAVADOC:4570 + + jakarta.faces.component.html + HtmlSelectOneMenu.PropertyKeys + + + + + JSF:JAVADOC:4571 + + jakarta.faces.component.html + HtmlSelectOneMenu.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:4572 + + jakarta.faces.component.html + HtmlSelectOneMenu.PropertyKeys + + + + + JSF:JAVADOC:4573 + Return the value of the accesskey property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4574 + Return the value of the border property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4575 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getDefaultEventName. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must provide an implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4576 + Return the value of the dir property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4577 + Return the value of the disabledClass property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4578 + Return the value of the enabledClass property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4579 + This is a default implementation of jakarta.faces.component.behavior.ClientBehaviorHolder#getEventNames. UIComponent does not implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface, but provides default implementations for the methods defined by jakarta.faces.component.behavior.ClientBehaviorHolder to simplify subclass implementations. Subclasses that wish to support the jakarta.faces.component.behavior.ClientBehaviorHolder contract must declare that the subclass implements jakarta.faces.component.behavior.ClientBehaviorHolder, and must override this method to return a non-Empty Collection of the client event names that the component supports. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4580 + Return the value of the group property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4581 + Return the value of the label property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4582 + Return the value of the lang property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4583 + Return the value of the layout property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4584 + Return the value of the onblur property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4585 + Return the value of the onchange property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4586 + Return the value of the onclick property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4587 + Return the value of the ondblclick property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4588 + Return the value of the onfocus property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4589 + Return the value of the onkeydown property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4590 + Return the value of the onkeypress property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4591 + Return the value of the onkeyup property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4592 + Return the value of the onmousedown property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4593 + Return the value of the onmousemove property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4594 + Return the value of the onmouseout property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4595 + Return the value of the onmouseover property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4596 + Return the value of the onmouseup property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4597 + Return the value of the onselect property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4598 + Return the value of the role property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4599 + Return the value of the style property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4600 + Return the value of the styleClass property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4601 + Return the value of the tabindex property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4602 + Return the value of the title property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4603 + + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4604 + Return the value of the disabled property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4605 + Return the value of the readonly property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + + + JSF:JAVADOC:4606 + Set the value of the accesskey property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4607 + Set the value of the border property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + int + + + + + + JSF:JAVADOC:4608 + Set the value of the dir property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4609 + Set the value of the disabled property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + boolean + + + + + + JSF:JAVADOC:4610 + Set the value of the disabledClass property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4611 + Set the value of the enabledClass property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4612 + Set the value of the group property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4613 + Set the value of the label property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4614 + Set the value of the lang property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4615 + Set the value of the layout property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4616 + Set the value of the onblur property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4617 + Set the value of the onchange property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4618 + Set the value of the onclick property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4619 + Set the value of the ondblclick property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4620 + Set the value of the onfocus property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4621 + Set the value of the onkeydown property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4622 + Set the value of the onkeypress property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4623 + Set the value of the onkeyup property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4624 + Set the value of the onmousedown property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4625 + Set the value of the onmousemove property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4626 + Set the value of the onmouseout property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4627 + Set the value of the onmouseover property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4628 + Set the value of the onmouseup property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4629 + Set the value of the onselect property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4630 + Set the value of the readonly property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + boolean + + + + + + JSF:JAVADOC:4631 + Set the value of the role property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4632 + Set the value of the style property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4633 + Set the value of the styleClass property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4634 + Set the value of the tabindex property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4635 + Set the value of the title property. + jakarta.faces.component.html + HtmlSelectOneRadio + + + java.lang.String + + + + + + JSF:JAVADOC:4636 + + jakarta.faces.component.html + HtmlSelectOneRadio.PropertyKeys + + + + + JSF:JAVADOC:4637 + + jakarta.faces.component.html + HtmlSelectOneRadio.PropertyKeys + + + java.lang.String + + + + + + JSF:JAVADOC:4638 + + jakarta.faces.component.html + HtmlSelectOneRadio.PropertyKeys + + + + + JSF:JAVADOC:4639 + Construct a new exception with no detail message or root cause. + jakarta.faces.component.search + ComponentNotFoundException + + + + + JSF:JAVADOC:4640 + Construct a new exception with the specified detail message and no root cause. + jakarta.faces.component.search + ComponentNotFoundException + + + java.lang.String + + + + + + JSF:JAVADOC:4641 + Construct a new exception with the specified root cause. The detail message will be set to (cause == null ? null : cause.toString() + jakarta.faces.component.search + ComponentNotFoundException + + + java.lang.Throwable + + + + + + JSF:JAVADOC:4642 + Construct a new exception with the specified detail message and root cause. + jakarta.faces.component.search + ComponentNotFoundException + + + java.lang.String + java.lang.Throwable + + + + + + JSF:JAVADOC:4643 + Creates a SearchExpressionContext instance for use with the SearchExpressionHandler. This method can be used to obtain a SearchExpressionContext instance without any VisitHint or SearchExpressionHint. + jakarta.faces.component.search + SearchExpressionContext + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:4644 + Creates a SearchExpressionContext instance for use with the SearchExpressionHandler. + jakarta.faces.component.search + SearchExpressionContext + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.util.Set + java.util.Set + + + + + + JSF:JAVADOC:4645 + Returns hints that influence the behavior of resolving the expression. + jakarta.faces.component.search + SearchExpressionContext + + + + + JSF:JAVADOC:4646 + Returns the FacesContext for the current request. + jakarta.faces.component.search + SearchExpressionContext + + + + + JSF:JAVADOC:4647 + Returns the source / base component from which we will start to perform our search. + jakarta.faces.component.search + SearchExpressionContext + + + + + JSF:JAVADOC:4648 + Returns hints that influence the behavior of the tree visit, if it's used by an SearchKeywordResolver implementation. + jakarta.faces.component.search + SearchExpressionContext + + + + + JSF:JAVADOC:4649 + + jakarta.faces.component.search + SearchExpressionContext + + + + + JSF:JAVADOC:4650 + Creates a SearchExpressionContext instance for use with the SearchExpressionHandler. + jakarta.faces.component.search + SearchExpressionContextFactory + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.util.Set + java.util.Set + + + + + + JSF:JAVADOC:4651 + If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped. + jakarta.faces.component.search + SearchExpressionContextFactory + + + + + JSF:JAVADOC:4652 + If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.component.search + SearchExpressionContextFactory + + + jakarta.faces.component.search.SearchExpressionContextFactory + + + + + + JSF:JAVADOC:4653 + Return the characters used to separate expressions in a series of expressions. The default implementation returns SearchExpressionHandler#EXPRESSION_SEPARATOR_CHARS. + jakarta.faces.component.search + SearchExpressionHandler + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:4654 + Resolves multiple UIComponents for the given expression. For each resolved component, the ContextCallback will be invoked. This method is the most essential method in the API. It implements the algorithm which handles the recursion of the keywords and id's. + jakarta.faces.component.search + SearchExpressionHandler + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + jakarta.faces.component.ContextCallback + + + + + + JSF:JAVADOC:4655 + Resolves multiple UIComponents for the given expression. For each resolved component, the ContextCallback will be invoked. This method is the most essential method in the API. It implements the algorithm which handles the recursion of the keywords and id's. + jakarta.faces.component.search + SearchExpressionHandler + + + jakarta.faces.component.search.SearchExpressionContext + jakarta.faces.component.UIComponent + java.lang.String + jakarta.faces.component.ContextCallback + + + + + + JSF:JAVADOC:4656 + Checks if the given expression is a "passtrough expression". A passthrough expression must only be a keyword. This keyword will not be resolved by the SearchKeywordResolver and will be returned untouched. The client is responsible to resolve it later. + jakarta.faces.component.search + SearchExpressionHandler + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + + + + + + JSF:JAVADOC:4657 + Checks if the given expression is a valid expression. A expression is invalid if: No SearchKeywordResolver matches the requested keyword A keyword or id is placed after a leaf keyword (@none:@form) + jakarta.faces.component.search + SearchExpressionHandler + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + + + + + + JSF:JAVADOC:4658 + Resolves to a single clientId or passthrough expression for the given expression. + jakarta.faces.component.search + SearchExpressionHandler + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + + + + + + JSF:JAVADOC:4659 + Resolves to a List with clientIds or passthrough expressions for the given expressions. The expressions will be splitted by #splitExpressions(jakarta.faces.context.FacesContext, java.lang.String) and resolved one by one. + jakarta.faces.component.search + SearchExpressionHandler + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + + + + + + JSF:JAVADOC:4660 + Resolves a single UIComponents for the given expression. If the component is resolved, the ContextCallback will be invoked. + jakarta.faces.component.search + SearchExpressionHandler + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + jakarta.faces.component.ContextCallback + + + + + + JSF:JAVADOC:4661 + Resolves multiple UIComponents for the given expression(s). The expressions will be splitted by #splitExpressions(jakarta.faces.context.FacesContext, java.lang.String) and resolved one by one. For each resolved component, the ContextCallback will be invoked. + jakarta.faces.component.search + SearchExpressionHandler + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + jakarta.faces.component.ContextCallback + + + + + + JSF:JAVADOC:4662 + + jakarta.faces.component.search + SearchExpressionHandler + + + + + JSF:JAVADOC:4663 + Splits an string, based on #getExpressionSeperatorChars(jakarta.faces.context.FacesContext) with possible multiple expressions into an array. + jakarta.faces.component.search + SearchExpressionHandler + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:4664 + Return the characters used to separate expressions in a series of expressions. The default implementation returns SearchExpressionHandler#EXPRESSION_SEPARATOR_CHARS. + jakarta.faces.component.search + SearchExpressionHandlerWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:4665 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.component.search + SearchExpressionHandlerWrapper + + + + + JSF:JAVADOC:4666 + Resolves multiple UIComponents for the given expression. For each resolved component, the ContextCallback will be invoked. This method is the most essential method in the API. It implements the algorithm which handles the recursion of the keywords and id's. + jakarta.faces.component.search + SearchExpressionHandlerWrapper + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + jakarta.faces.component.ContextCallback + + + + + + JSF:JAVADOC:4667 + Resolves multiple UIComponents for the given expression. For each resolved component, the ContextCallback will be invoked. This method is the most essential method in the API. It implements the algorithm which handles the recursion of the keywords and id's. + jakarta.faces.component.search + SearchExpressionHandlerWrapper + + + jakarta.faces.component.search.SearchExpressionContext + jakarta.faces.component.UIComponent + java.lang.String + jakarta.faces.component.ContextCallback + + + + + + JSF:JAVADOC:4668 + Checks if the given expression is a "passtrough expression". A passthrough expression must only be a keyword. This keyword will not be resolved by the SearchKeywordResolver and will be returned untouched. The client is responsible to resolve it later. + jakarta.faces.component.search + SearchExpressionHandlerWrapper + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + + + + + + JSF:JAVADOC:4669 + Checks if the given expression is a valid expression. A expression is invalid if: No SearchKeywordResolver matches the requested keyword A keyword or id is placed after a leaf keyword (@none:@form) + jakarta.faces.component.search + SearchExpressionHandlerWrapper + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + + + + + + JSF:JAVADOC:4670 + Resolves to a single clientId or passthrough expression for the given expression. + jakarta.faces.component.search + SearchExpressionHandlerWrapper + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + + + + + + JSF:JAVADOC:4671 + Resolves to a List with clientIds or passthrough expressions for the given expressions. The expressions will be splitted by #splitExpressions(jakarta.faces.context.FacesContext, java.lang.String) and resolved one by one. + jakarta.faces.component.search + SearchExpressionHandlerWrapper + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + + + + + + JSF:JAVADOC:4672 + Resolves a single UIComponents for the given expression. If the component is resolved, the ContextCallback will be invoked. + jakarta.faces.component.search + SearchExpressionHandlerWrapper + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + jakarta.faces.component.ContextCallback + + + + + + JSF:JAVADOC:4673 + Resolves multiple UIComponents for the given expression(s). The expressions will be splitted by #splitExpressions(jakarta.faces.context.FacesContext, java.lang.String) and resolved one by one. For each resolved component, the ContextCallback will be invoked. + jakarta.faces.component.search + SearchExpressionHandlerWrapper + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + jakarta.faces.component.ContextCallback + + + + + + JSF:JAVADOC:4674 + If this search expression handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.component.search + SearchExpressionHandlerWrapper + + + jakarta.faces.component.search.SearchExpressionHandler + + + + + + JSF:JAVADOC:4675 + Splits an string, based on #getExpressionSeperatorChars(jakarta.faces.context.FacesContext) with possible multiple expressions into an array. + jakarta.faces.component.search + SearchExpressionHandlerWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:4676 + + jakarta.faces.component.search + SearchExpressionHint + + + java.lang.String + + + + + + JSF:JAVADOC:4677 + + jakarta.faces.component.search + SearchExpressionHint + + + + + JSF:JAVADOC:4678 + Returns the ContextCallback for the current request. + jakarta.faces.component.search + SearchKeywordContext + + + + + JSF:JAVADOC:4679 + Returns the remaining expression for the current request. + jakarta.faces.component.search + SearchKeywordContext + + + + + JSF:JAVADOC:4680 + Returns the SearchExpressionContext for the current request. + jakarta.faces.component.search + SearchKeywordContext + + + + + JSF:JAVADOC:4681 + This method will be called by an implementation of SearchKeywordResolver#resolve with the resolved component for the keyword. + jakarta.faces.component.search + SearchKeywordContext + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:4682 + Returns if the keyword was resolved. + jakarta.faces.component.search + SearchKeywordContext + + + + + JSF:JAVADOC:4683 + Construct a new context with the given arguments. + jakarta.faces.component.search + SearchKeywordContext + + + jakarta.faces.component.search.SearchExpressionContext + jakarta.faces.component.ContextCallback + java.lang.String + + + + + + JSF:JAVADOC:4684 + Sets if the keyword was resolved. + jakarta.faces.component.search + SearchKeywordContext + + + boolean + + + + + + JSF:JAVADOC:4685 + A leaf keyword is a keyword that does not allow to be combined with keywords or id chains to the right. For example: @none:@parent. + jakarta.faces.component.search + SearchKeywordResolver + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + + + + + + JSF:JAVADOC:4686 + A passthrough keyword is a keyword, that according to the context, does not require to be resolved on the server, and can be passed "unresolved" to the client. + jakarta.faces.component.search + SearchKeywordResolver + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + + + + + + JSF:JAVADOC:4687 + Checks if the current instance of the SearchKeywordResolver is responsible for resolving the keyword. + jakarta.faces.component.search + SearchKeywordResolver + + + jakarta.faces.component.search.SearchExpressionContext + java.lang.String + + + + + + JSF:JAVADOC:4688 + Try to resolve one or multiple UIComponents based on the keyword and calls SearchKeywordContext#invokeContextCallback(jakarta.faces.component.UIComponent) for each resolved component. + jakarta.faces.component.search + SearchKeywordResolver + + + jakarta.faces.component.search.SearchKeywordContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:4689 + + jakarta.faces.component.search + SearchKeywordResolver + + + + + JSF:JAVADOC:4690 + This method is called during component tree visits by VisitContext#invokeVisitCallback VisitContext.invokeVisitCallback() to visit the specified component. At the point in time when this method is called, the argument target is guaranteed to be in the proper state with respect to its ancestors in the View. + jakarta.faces.component.visit + VisitCallback + + + jakarta.faces.component.visit.VisitContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:4691 + Returns a VisitContext instance that is initialized with the specified ids and hintsfor use with UIComponent#visitTree. + jakarta.faces.component.visit + VisitContext + + + jakarta.faces.context.FacesContext + java.util.Collection + java.util.Set + + + + + + JSF:JAVADOC:4692 + Creates a VisitContext instance for use with UIComponent#visitTree UIComponent.visitTree(). This method can be used to obtain a VisitContext instance when all components should be visited with the default visit hints. + jakarta.faces.component.visit + VisitContext + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:4693 + Returns the FacesContext for the current request. + jakarta.faces.component.visit + VisitContext + + + + + JSF:JAVADOC:4694 + Returns hints that influence the behavior of the tree visit. Interested parties, such as UIComponent#visitTree UIComponent.visitTree() implementations, may check to see whether a particular hint is present by calling VisitContext.getHints().contains(), passing in one of the hints defined by VisitHint. + jakarta.faces.component.visit + VisitContext + + + + + JSF:JAVADOC:4695 + Returns the ids of the components to visit. In the case of a full tree visit, this method returns the ALL_IDS collection. Otherwise, if a partial visit is beign performed, returns a modifiable collection containing the client ids of the components that should be visited. + jakarta.faces.component.visit + VisitContext + + + + + JSF:JAVADOC:4696 + Given a jakarta.faces.component.NamingContainer component, returns the client ids of any components underneath the NamingContainer that should be visited. This method is called by NamingContainer visitTree() implementations to determine whether the NamingContainer contains components to be visited. In the case where no such components exist, the NamingContainer can short-circuit the tree visit and avoid descending into child subtrees. In addition, iterating components such as UIData may be able to use the returned ids to determine which iterated states (ie. rows) need to be visited. This allows the visit traversal to be contstrained such only those rows that contain visit targets need to be traversed. + jakarta.faces.component.visit + VisitContext + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:4697 + Called by UIComponent#visitTree UIComponent.visitTree() to visit a single component. + jakarta.faces.component.visit + VisitContext + + + jakarta.faces.component.UIComponent + jakarta.faces.component.visit.VisitCallback + + + + + + JSF:JAVADOC:4698 + + jakarta.faces.component.visit + VisitContext + + + + + JSF:JAVADOC:4699 + Return a new VisitContext instance. + jakarta.faces.component.visit + VisitContextFactory + + + jakarta.faces.context.FacesContext + java.util.Collection + java.util.Set + + + + + + JSF:JAVADOC:4700 + If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped. + jakarta.faces.component.visit + VisitContextFactory + + + + + JSF:JAVADOC:4701 + + jakarta.faces.component.visit + VisitContextFactory + + + + + JSF:JAVADOC:4702 + If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.component.visit + VisitContextFactory + + + jakarta.faces.component.visit.VisitContextFactory + + + + + + JSF:JAVADOC:4703 + Returns the FacesContext for the current request. + jakarta.faces.component.visit + VisitContextWrapper + + + + + JSF:JAVADOC:4704 + Returns hints that influence the behavior of the tree visit. Interested parties, such as UIComponent#visitTree UIComponent.visitTree() implementations, may check to see whether a particular hint is present by calling VisitContext.getHints().contains(), passing in one of the hints defined by VisitHint. + jakarta.faces.component.visit + VisitContextWrapper + + + + + JSF:JAVADOC:4705 + Returns the ids of the components to visit. In the case of a full tree visit, this method returns the ALL_IDS collection. Otherwise, if a partial visit is beign performed, returns a modifiable collection containing the client ids of the components that should be visited. + jakarta.faces.component.visit + VisitContextWrapper + + + + + JSF:JAVADOC:4706 + Given a jakarta.faces.component.NamingContainer component, returns the client ids of any components underneath the NamingContainer that should be visited. This method is called by NamingContainer visitTree() implementations to determine whether the NamingContainer contains components to be visited. In the case where no such components exist, the NamingContainer can short-circuit the tree visit and avoid descending into child subtrees. In addition, iterating components such as UIData may be able to use the returned ids to determine which iterated states (ie. rows) need to be visited. This allows the visit traversal to be contstrained such only those rows that contain visit targets need to be traversed. + jakarta.faces.component.visit + VisitContextWrapper + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:4707 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.component.visit + VisitContextWrapper + + + + + JSF:JAVADOC:4708 + Called by UIComponent#visitTree UIComponent.visitTree() to visit a single component. + jakarta.faces.component.visit + VisitContextWrapper + + + jakarta.faces.component.UIComponent + jakarta.faces.component.visit.VisitCallback + + + + + + JSF:JAVADOC:4709 + + jakarta.faces.component.visit + VisitContextWrapper + + + + + JSF:JAVADOC:4710 + If this visit context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.component.visit + VisitContextWrapper + + + jakarta.faces.component.visit.VisitContext + + + + + + JSF:JAVADOC:4711 + + jakarta.faces.component.visit + VisitHint + + + java.lang.String + + + + + + JSF:JAVADOC:4712 + + jakarta.faces.component.visit + VisitHint + + + + + JSF:JAVADOC:4713 + + jakarta.faces.component.visit + VisitResult + + + java.lang.String + + + + + + JSF:JAVADOC:4714 + + jakarta.faces.component.visit + VisitResult + + + + + JSF:JAVADOC:4715 + + jakarta.faces.context + ExceptionHandler + + + + + JSF:JAVADOC:4716 + Return the first ExceptionQueuedEvent handled by this handler. + jakarta.faces.context + ExceptionHandler + + + + + JSF:JAVADOC:4717 + The default implementation must return an Iterable over all ExceptionQueuedEvents that have been handled by the #handle method. + jakarta.faces.context + ExceptionHandler + + + + + JSF:JAVADOC:4718 + Unwrap the argument t until the unwrapping encounters an Object whose getClass() is not equal to FacesException.class or jakarta.el.ELException.class. If there is no root cause, null is returned. + jakarta.faces.context + ExceptionHandler + + + java.lang.Throwable + + + + + + JSF:JAVADOC:4719 + Return an Iterable over all ExceptionQueuedEvents that have not yet been handled by the #handle method. + jakarta.faces.context + ExceptionHandler + + + + + JSF:JAVADOC:4720 + Take action to handle the Exception instances residing inside the ExceptionQueuedEvent instances that have been queued by calls to Application().publishEvent(ExceptionQueuedEvent.class, eventContext). The requirements of the default implementation are detailed in section 6.2.1 "Default ExceptionHandler implementation" of the Jakarta Faces Specification Document. + jakarta.faces.context + ExceptionHandler + + + + + JSF:JAVADOC:4721 + if and only if a problem occurs while performing the algorithm to handle the Exception, not as a means of conveying a handled Exception itself. + jakarta.faces.context + ExceptionHandler + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:4722 + + jakarta.faces.context + ExceptionHandler + + + java.lang.Object + + + + + + JSF:JAVADOC:4723 + + jakarta.faces.context + ExceptionHandler + + + jakarta.faces.event.SystemEvent + + + + + + JSF:JAVADOC:4724 + + jakarta.faces.context + ExceptionHandler + + + jakarta.faces.event.SystemEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:4725 + + jakarta.faces.context + ExceptionHandlerFactory + + + + + JSF:JAVADOC:4726 + If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.context + ExceptionHandlerFactory + + + jakarta.faces.context.ExceptionHandlerFactory + + + + + + JSF:JAVADOC:4727 + Create and return a A new ExceptionHandler instance. The implementation must return an ExceptionHandler instance suitable for the environment. For example, in some cases it may be desirable for an ExceptionHandler to write error information to the response instead of throwing exceptions as in the case of Ajax applications. + jakarta.faces.context + ExceptionHandlerFactory + + + + + JSF:JAVADOC:4728 + If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped. + jakarta.faces.context + ExceptionHandlerFactory + + + + + JSF:JAVADOC:4729 + + jakarta.faces.context + ExceptionHandlerWrapper + + + + + JSF:JAVADOC:4730 + If this exception handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.context + ExceptionHandlerWrapper + + + jakarta.faces.context.ExceptionHandler + + + + + + JSF:JAVADOC:4731 + The default behavior of this method is to call ExceptionHandler#getHandledExceptionQueuedEvent() on the wrapped ExceptionHandler object. + jakarta.faces.context + ExceptionHandlerWrapper + + + + + JSF:JAVADOC:4732 + The default behavior of this method is to call ExceptionHandler#getHandledExceptionQueuedEvents() on the wrapped ExceptionHandler object. + jakarta.faces.context + ExceptionHandlerWrapper + + + + + JSF:JAVADOC:4733 + The default behavior of this method is to call jakarta.faces.context.ExceptionHandler#getRootCause(Throwable) on the wrapped ExceptionHandler object. + jakarta.faces.context + ExceptionHandlerWrapper + + + java.lang.Throwable + + + + + + JSF:JAVADOC:4734 + The default behavior of this method is to call ExceptionHandler#getUnhandledExceptionQueuedEvents() on the wrapped ExceptionHandler object. + jakarta.faces.context + ExceptionHandlerWrapper + + + + + JSF:JAVADOC:4735 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.context + ExceptionHandlerWrapper + + + + + JSF:JAVADOC:4736 + The default behavior of this method is to call jakarta.faces.context.ExceptionHandler#handle() on the wrapped ExceptionHandler object. + jakarta.faces.context + ExceptionHandlerWrapper + + + + + JSF:JAVADOC:4737 + + jakarta.faces.context + ExceptionHandlerWrapper + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:4738 + The default behavior of this method is to call jakarta.faces.context.ExceptionHandler#isListenerForSource(Object) on the wrapped ExceptionHandler object. + jakarta.faces.context + ExceptionHandlerWrapper + + + java.lang.Object + + + + + + JSF:JAVADOC:4739 + The default behavior of this method is to call jakarta.faces.context.ExceptionHandler#processEvent(jakarta.faces.event.SystemEvent) on the wrapped ExceptionHandler object. + jakarta.faces.context + ExceptionHandlerWrapper + + + jakarta.faces.event.SystemEvent + + + + + + JSF:JAVADOC:4740 + + jakarta.faces.context + ExceptionHandlerWrapper + + + jakarta.faces.event.SystemEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:4741 + Adds the cookie represented by the arguments to the response. Jakarta Servlet: This must be accomplished by calling the jakarta.servlet.http.HttpServletResponse method addCookie(). The Cookie argument must be constructed by passing the name and value parameters. If the properties arugument is non-null and not empty, the Cookie instance must be initialized as described below. Cookie handling table Key in "values" Map (case sensitive) Expected type of value. Name of setter method on Cookie instance to be set with the value from the Map. comment String setComment domain String setDomain maxAge Integer setMaxAge secure Boolean setSecure path String setPath httpOnly Boolean setHttpOnly any other attribute (e.g. SameSite) String setAttribute The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + java.lang.String + java.lang.String + java.util.Map + + + + + + JSF:JAVADOC:4742 + Add the given name and value to the response header. Jakarta Servlet:This must be performed by calling the jakarta.servlet.http.HttpServletResponse addHeader method. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:4743 + Dispatch a request to the specified resource to create output for this response. Jakarta Servlet: This must be accomplished by calling the jakarta.servlet.ServletContext method getRequestDispatcher(path), and calling the forward() method on the resulting object. If the call to getRequestDisatcher(path) returns null, send aServletResponse SC_NOT_FOUND error code. + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4744 + if an input/output error occurs + jakarta.faces.context + ExternalContext + + + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:4745 + Return the input URL, after performing any rewriting needed to ensure that it will correctly identify an addressable action in the current application. Encoding the jakarta.faces.lifecycle.ClientWindow Call jakarta.faces.lifecycle.ClientWindow#isClientWindowRenderModeEnabled(jakarta.faces.context.FacesContext) . If the result is false take no further action and return the rewritten URL. If the result is true, call #getClientWindow(). If the result is non-null, call jakarta.faces.lifecycle.ClientWindow#getId() and append the id to the query string of the URL, making the necessary allowances for a pre-existing query string or no query-string. Call jakarta.faces.lifecycle.ClientWindow#getQueryURLParameters. If the result is non-null, for each parameter in the map, unconditionally add that parameter to the URL. The name of the query string parameter is given by the value of the constant jakarta.faces.render.ResponseStateManager#CLIENT_WINDOW_URL_PARAM. Jakarta Servlet: This must be the value returned by the jakarta.servlet.http.HttpServletResponse method encodeURL(url). + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4746 + The purpose of this method is to generate a query string from the collection of Parameter objects provided by the parameters argument and append that query string to the baseUrl. This method must be able to encode the parameters to a baseUrl that may or may not have existing query parameters. The parameter values should be encoded appropriately for the environment so that the resulting URL can be used as the target of a link (e.g., in an href attribute) in a Jakarta Faces response. It's possible for an ExternalContext implementation to override this method in any way that would make the URL bookmarkable in that environment. See #encodeActionURL(java.lang.String) for the required specification of how to encode the jakarta.faces.lifecycle.ClientWindow. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + java.lang.String + java.util.Map + + + + + + JSF:JAVADOC:4747 + Return the specified name, after prefixing it with a namespace that ensures that it will be unique within the context of a particular page. Jakarta Servlet: The input value must be returned unchanged. + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4748 + Return the input URL, after performing any rewriting needed to ensure that it can be used in a partial page submission (ajax request) to correctly identify an addressable action in the current application. See #encodeActionURL(java.lang.String) for the required specification of how to encode the jakarta.faces.lifecycle.ClientWindow. Jakarta Servlet:Returns the same encoded URL as the #encodeActionURL(String url) method. Portlet:Returns an encoded URL that, upon HTTP POST, will invoke the RESOURCE_PHASE of the portlet lifecycle. + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4749 + The purpose of this method is to generate a query string from the collection of Parameter objects provided by the parameters argument and append that query string to the baseUrl. This method must be able to encode the parameters to a baseUrl that may or may not have existing query parameters. The parameter values should be encoded appropriately for the environment so that the resulting URL can be used as the target of a redirect. It's possible for an ExternalContext implementation to override this method to accomodate the definition of redirect for that environment. See #encodeActionURL(java.lang.String) for the required specification of how to encode the jakarta.faces.lifecycle.ClientWindow. + jakarta.faces.context + ExternalContext + + + java.lang.String + java.util.Map + + + + + + JSF:JAVADOC:4750 + Return the input URL, after performing any rewriting needed to ensure that it will correctly identify an addressable resource in the current application. Jakarta Servlet: This must be the value returned by the jakarta.servlet.http.HttpServletResponse method encodeURL(url). + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4751 + Return the websocket URL, after performing any rewriting needed to ensure that it will correctly identify an addressable websocket in the current application. Jakarta Servlet: This must ensure that the input URL is prefixed with the correct websocket scheme, domain and port and then encoded by #encodeResourceURL(String). + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4752 + + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4753 + Return the name of the container context for this application. Jakarta Servlet: Return the result of calling getContextPath() on the ServletContext instance for this application. It is valid to call this method during application startup or shutdown. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4754 + Return a mutable Map representing the application scope attributes for the current application. The returned Map must implement the entire contract for a modifiable map as described in the JavaDocs for java.util.Map. Modifications made in the Map must cause the corresponding changes in the set of application scope attributes. Particularly the clear(), remove(), put(), putAll(), and get() operations must take the appropriate action on the underlying data structure. It is valid to call this method during application startup or shutdown. If called at startup or shutdown time, this method returns a Map that is backed by the same container context instance (ServletContext or PortletContext) as the one returned by calling getApplicationMap() on the ExternalContext returned by the FacesContext during an actual request. Jakarta Servlet: This must be the set of attributes available via the jakarta.servlet.ServletContext methods getAttribute(), getAttributeNames(), removeAttribute(), and setAttribute(). + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4755 + Return the name of the authentication scheme used to authenticate the current user, if any; otherwise, return null. For standard authentication schemes, the returned value will match one of the following constants: BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, or FORM_AUTH. Jakarta Servlet: This must be the value returned by the jakarta.servlet.http.HttpServletRequest method getAuthType(). + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4756 + Return the ClientWindow set in a preceding call to #setClientWindow, or null if no such call has been made. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4757 + Return the application environment object instance for the current appication. It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this returns the same container context instance (ServletContext or PortletContext) as the one returned when calling getContext() on the ExternalContext returned by the FacesContext during an actual request. Jakarta Servlet: This must be the current application's jakarta.servlet.ServletContext instance. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4758 + Return the name of the container context for this application. Return the result of calling getServletContextName() on the ServletContext instance for this application. It is valid to call this method during application startup or shutdown. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4759 + Return the threadsafe Flash for this application. The default implementation will throw UnsupportedOperationException. Compliant Jakarta Faces runtimes must provide an implementation of this method. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4760 + Return the value of the specified application initialization parameter (if any). Jakarta Servlet: This must be the result of the jakarta.servlet.ServletContext method getInitParameter(name). It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method calls through to the actual container context to return the init parameter value. + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4761 + Return an immutable Map whose keys are the set of application initialization parameter names configured for this application, and whose values are the corresponding parameter values. The returned Map must implement the entire contract for an unmodifiable map as described in the JavaDocs for java.util.Map. It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method returns a Map that is backed by the same container context instance (ServletContext or PortletContext) as the one returned by calling getInitParameterMap() on the ExternalContext returned by the FacesContext during an actual request. Jakarta Servlet: This result must be as if it were synthesized by calling the jakarta.servlet.ServletContext method getInitParameterNames, and putting each configured parameter name/value pair into the result. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4762 + Returns the MIME type of the specified file or null if the MIME type is not known. The MIME type is determined by the container. It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method calls through to the getMimeType() method on the same container context instance (ServletContext or PortletContext) as the one used when calling getMimeType() on the ExternalContext returned by the FacesContext during an actual request. Jakarta Servlet: This must be the value returned by the jakarta.servlet.ServletContext method getMimeType(). + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4763 + Returns a String containing the real path for a given virtual path. It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method calls through to the getRealPath() method on the same container context instance (ServletContext or PortletContext) as the one used when calling getRealPath() on the ExternalContext returned by the FacesContext during an actual request. Jakarta Servlet: This must be the value returned by the jakarta.servlet.ServletContext method getRealPath(). The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4764 + Return the login name of the user making the current request if any; otherwise, return null. Jakarta Servlet: This must be the value returned by the jakarta.servlet.http.HttpServletRequest method getRemoteUser(). + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4765 + Return the environment-specific object instance for the current request. Jakarta Servlet: This must be the current request's jakarta.servlet.http.HttpServletRequest instance. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4766 + Return the character encoding currently being used to interpret this request. Jakarta Servlet: This must return the value returned by the jakarta.servlet.ServletRequest method getCharacterEncoding(). The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4767 + Return the result of calling getContentLenth() on the ServletRequest instance for this request. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4768 + Return the MIME Content-Type for this request. If not available, return null. Jakarta Servlet: This must return the value returned by the jakarta.servlet.ServletRequest method getContentType(). The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4769 + Return the portion of the request URI that identifies the web application context for this request. Jakarta Servlet: This must be the value returned by the jakarta.servlet.http.HttpServletRequest method getContextPath(). + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4770 + Return an immutable Map whose keys are the set of cookie names included in the current request, and whose values (of type jakarta.servlet.http.Cookie) are the first (or only) cookie for each cookie name returned by the underlying request. The returned Map must implement the entire contract for an unmodifiable map as described in the JavaDocs for java.util.Map. Jakarta Servlet: This must be the value returned by the jakarta.servlet.http.HttpServletRequest method getCookies(), unless null was returned, in which case this must be a zero-length array. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4771 + Return an immutable Map whose keys are the set of request header names included in the current request, and whose values (of type String) are the first (or only) value for each header name returned by the underlying request. The returned Map must implement the entire contract for an unmodifiable map as described in the JavaDocs for java.util.Map. In addition, key comparisons must be performed in a case insensitive manner. Jakarta Servlet: This must be the set of headers available via the jakarta.servlet.http.HttpServletRequest methods getHeader() and getHeaderNames(). + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4772 + Return an immutable Map whose keys are the set of request header names included in the current request, and whose values (of type String[]) are all of the value for each header name returned by the underlying request. The returned Map must implement the entire contract for an unmodifiable map as described in the JavaDocs for java.util.Map. In addition, key comparisons must be performed in a case insensitive manner. Jakarta Servlet: This must be the set of headers available via the jakarta.servlet.http.HttpServletRequest methods getHeaders() and getHeaderNames(). + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4773 + Return the preferred Locale in which the client will accept content. Jakarta Servlet: This must be the value returned by the jakarta.servlet.ServletRequest method getLocale(). + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4774 + Return an Iterator over the preferred Locales specified in the request, in decreasing order of preference. Jakarta Servlet: This must be an Iterator over the values returned by the jakarta.servlet.ServletRequest method getLocales(). + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4775 + Return a mutable Map representing the request scope attributes for the current application. The returned Map must implement the entire contract for a modifiable map as described in the JavaDocs for java.util.Map. Modifications made in the Map must cause the corresponding changes in the set of request scope attributes. Particularly the clear(), remove(), put(), putAll(), and get() operations must take the appropriate action on the underlying data structure. Jakarta Servlet: This must be the set of attributes available via the jakarta.servlet.ServletRequest methods getAttribute(), getAttributeNames(), removeAttribute(), and setAttribute(). + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4776 + Return an immutable Map whose keys are the set of request parameters names included in the current request, and whose values (of type String) are the first (or only) value for each parameter name returned by the underlying request. The returned Map must implement the entire contract for an unmodifiable map as described in the JavaDocs for java.util.Map. Jakarta Servlet: This must be the set of parameters available via the jakarta.servlet.ServletRequest methods getParameter() and getParameterNames(). + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4777 + Return an Iterator over the names of all request parameters included in the current request. Jakarta Servlet: This must be an Iterator over the values returned by the jakarta.servlet.ServletRequest method getParameterNames(). + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4778 + Return an immutable Map whose keys are the set of request parameters names included in the current request, and whose values (of type String[]) are all of the values for each parameter name returned by the underlying request. The returned Map must implement the entire contract for an unmodifiable map as described in the JavaDocs for java.util.Map. Jakarta Servlet: This must be the set of parameters available via the jakarta.servlet.ServletRequest methods getParameterValues() and getParameterNames(). + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4779 + Return the extra path information (if any) included in the request URI; otherwise, return null. Jakarta Servlet: This must be the value returned by the jakarta.servlet.http.HttpServletRequest method getPathInfo(). + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4780 + Returns the name of the scheme used to make this request, for example, http, https, or ftp. Jakarta Servlet: This must be the value returned by the jakarta.servlet.ServletRequest method getScheme(). The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4781 + Returns the host name of the server to which the request was sent. Jakarta Servlet: This must be the value returned by the jakarta.servlet.ServletRequest method getServerName(). The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4782 + Returns the port number to which the request was sent. Jakarta Servlet: This must be the value returned by the jakarta.servlet.ServletRequest method getServerPort(). The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4783 + Return the Jakarta Servlet path information (if any) included in the request URI; otherwise, return null. Jakarta Servlet: This must be the value returned by the jakarta.servlet.http.HttpServletRequest method getServletPath(). + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4784 + Return a URL for the application resource mapped to the specified path, if it exists; otherwise, return null. It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method calls through to the getResource() method on the same container context instance (ServletContext or PortletContext) as the one used when calling getResource() on the ExternalContext returned by the FacesContext during an actual request. Jakarta Servlet: This must be the value returned by the jakarta.servlet.ServletContext method getResource(path). + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4785 + if the specified path is not in the correct form + jakarta.faces.context + ExternalContext + + + java.lang.String + + java.net.MalformedURLException + + + + + JSF:JAVADOC:4786 + Return an InputStream for an application resource mapped to the specified path, if it exists; otherwise, return null. It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method calls through to the getResourceAsStream() method on the same container context instance (ServletContext or PortletContext) as the one used when calling getResourceAsStream() on the ExternalContext returned by the FacesContext during an actual request. Jakarta Servlet: This must be the value returned by the jakarta.servlet.ServletContext method getResourceAsStream(path). + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4787 + Return the Set of resource paths for all application resources whose resource path starts with the specified argument. It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method calls through to the getResourcePaths() method on the same container context instance (ServletContext or PortletContext) as the one used when calling getResourcePaths() on the ExternalContext returned by the FacesContext during an actual request. Jakarta Servlet: This must be the value returned by the jakarta.servlet.ServletContext method getResourcePaths(path). + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4788 + Return the environment-specific object instance for the current response. Jakarta Servlet: This is the current request's jakarta.servlet.http.HttpServletResponse instance. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4789 + Return the buffer size for the current response. Jakarta Servlet: This must be performed by calling the jakarta.servlet.http.HttpServletResponse getBufferSize method. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4790 + Returns the name of the character encoding (MIME charset) used for the body sent in this response. Jakarta Servlet: This must return the value returned by the jakarta.servlet.ServletResponse method getCharacterEncoding(). Portlet: if this method is called during a lifecycle phase other than RENDER_RESPONSE, this must return null. If called during RENDER_RESPONSE, return the response encoding of the portlet response. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4791 + Return the MIME Content-Type for this response. If not available, return null. Jakarta Servlet: This must return the value returned by the jakarta.servlet.ServletResponse method getContentType(). The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4792 + Returns an OutputStream suitable for writing binary data to the user-agent. Jakarta Servlet: This must return the value returned by the jakarta.servlet.ServletResponse method getOutputStream(). The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4793 + any IO related exception. + jakarta.faces.context + ExternalContext + + java.io.IOException + + + + + JSF:JAVADOC:4794 + Returns a Writer suitable for writing character data to the user-agent. Jakarta Servlet: This must return the value returned by the jakarta.servlet.ServletResponse#getWriter. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4795 + any IO related exception. + jakarta.faces.context + ExternalContext + + java.io.IOException + + + + + JSF:JAVADOC:4796 + If the create parameter is true, create (if necessary) and return a session instance associated with the current request. If the create parameter is false return any existing session instance associated with the current request, or return null if there is no such session. Jakarta Servlet: This must return the result of calling getSession(create) on the underlying jakarta.servlet.http.HttpServletRequest instance. + jakarta.faces.context + ExternalContext + + + boolean + + + + + + JSF:JAVADOC:4797 + Return the id of the current session or the empty string if no session has been created and the create parameter is false. Jakarta Servlet: If create is true, obtain a reference to the HttpSession for the current request (creating the session if necessary) and return its id. If create is false, obtain a reference to the current session, if one exists, and return its id. If no session exists, return the empty string. + jakarta.faces.context + ExternalContext + + + boolean + + + + + + JSF:JAVADOC:4798 + Return a mutable Map representing the session scope attributes for the current application. The returned Map must implement the entire contract for a modifiable map as described in the JavaDocs for java.util.Map. Modifications made in the Map must cause the corresponding changes in the set of session scope attributes. Particularly the clear(), remove(), put(), and get() operations must take the appropriate action on the underlying data structure. Accessing attributes via this Map must cause the creation of a session associated with the current request, if such a session does not already exist. Jakarta Servlet: This must be the set of attributes available via the jakarta.servlet.http.HttpSession methods getAttribute(), getAttributeNames(), removeAttribute(), and setAttribute(). + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4799 + Returns the maximum time interval, in seconds, that the Jakarta Servlet container will keep this session open between client accesses. After this interval, the Jakarta Servlet container will invalidate the session. The maximum time interval can be set with the #setSessionMaxInactiveInterval method. A return value of zero or less indicates that the session will never timeout. Jakarta Servlet: This must return the result of calling getMaxInactiveInterval on the underlying jakarta.servlet.http.HttpSession instance. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4800 + Return the Principal object containing the name of the current authenticated user, if any; otherwise, return null. Jakarta Servlet: This must be the value returned by the jakarta.servlet.http.HttpServletRequest method getUserPrincipal(). + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4801 + Invalidates this session then unbinds any objects bound to it. Jakarta Servlet: This must be the value returned by the jakarta.servlet.http.HttpSession method invalidate(). The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4802 + Check if the current response has been committed. Jakarta Servlet: This must be performed by calling the jakarta.servlet.http.HttpServletResponse isCommitted method. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4803 + Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS. Jakarta Servlet: This must return the result of calling isSecure on the underlying jakarta.servlet.http.HttpServletRequest instance. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4804 + Return true if the currently authenticated user is included in the specified role. Otherwise, return false. Jakarta Servlet: This must be the value returned by the jakarta.servlet.http.HttpServletRequest method isUserInRole(role). + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4805 + Log the specified message to the application object. It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this calls the log() method on the same container context instance (ServletContext or PortletContext) as the one used during a call to log() on the ExternalContext returned by the FacesContext during an actual request. Jakarta Servlet: This must be performed by calling the jakarta.servlet.ServletContext method log(String). + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4806 + Log the specified message and exception to the application object. It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this calls the log() method on the same container context instance (ServletContext or PortletContext) as the one used when calling log() on the ExternalContext returned by the FacesContext during an actual request. Jakarta Servlet: This must be performed by calling the jakarta.servlet.ServletContext method log(String,Throwable). + jakarta.faces.context + ExternalContext + + + java.lang.String + java.lang.Throwable + + + + + + JSF:JAVADOC:4807 + Redirect a request to the specified URL, and cause the responseComplete() method to be called on the FacesContext instance for the current request. The implementation must determine if the request is an Ajax request by obtaining a PartialViewContext instance from the FacesContext and calling PartialViewContext#isAjaxRequest(). Jakarta Servlet: For non Ajax requests, this must be accomplished by calling the jakarta.servlet.http.HttpServletResponse method sendRedirect(). For Ajax requests, the implementation must: Get a PartialResponseWriter instance from the FacesContext. Call #setResponseContentType with text/xml Call #setResponseCharacterEncoding with UTF-8 Call #addResponseHeader with Cache-Control, no-cache Call PartialResponseWriter#startDocument Call PartialResponseWriter#redirect with the url argument. Call PartialResponseWriter#endDocument + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4808 + if an input/output error occurs + jakarta.faces.context + ExternalContext + + + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:4809 + Release any resources associated with this ExternalContext instance. This method is called during during destruction of the associated FacesContext. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4810 + Flushes the buffered response content to the client. Jakarta Servlet: This must be performed by calling the jakarta.servlet.http.HttpServletResponse flushBuffer method. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4811 + any IO related exception. + jakarta.faces.context + ExternalContext + + java.io.IOException + + + + + JSF:JAVADOC:4812 + Resets the current response. Jakarta Servlet: This must be performed by calling the jakarta.servlet.http.HttpServletResponse reset method. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + + + JSF:JAVADOC:4813 + Sends an HTTP status code with message. Jakarta Servlet: This must be performed by calling the jakarta.servlet.http.HttpServletResponse sendError method. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + int + java.lang.String + + + + + + JSF:JAVADOC:4814 + any IO related exceptions. + jakarta.faces.context + ExternalContext + + + int + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:4815 + Associate this instance with a ClientWindow. + jakarta.faces.context + ExternalContext + + + jakarta.faces.lifecycle.ClientWindow + + + + + + JSF:JAVADOC:4816 + Set the environment-specific request to be returned by subsequent calls to #getRequest. This may be used to install a wrapper for the request. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + java.lang.Object + + + + + + JSF:JAVADOC:4817 + Overrides the name of the character encoding used in the body of this request. Calling this method after the request has been accessed will have no no effect, unless a Reader or Stream has been obtained from the request, in which case an IllegalStateException is thrown. Jakarta Servlet: This must call through to the jakarta.servlet.ServletRequest method setCharacterEncoding(). The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4818 + if this is not a valid encoding + jakarta.faces.context + ExternalContext + + + java.lang.String + + java.io.UnsupportedEncodingException + + + + + JSF:JAVADOC:4819 + Set the environment-specific response to be returned by subsequent calls to #getResponse. This may be used to install a wrapper for the response. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + java.lang.Object + + + + + + JSF:JAVADOC:4820 + Set the buffer size for the current response. Jakarta Servlet: This must be performed by calling the jakarta.servlet.http.HttpServletResponse setBufferSize method. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + int + + + + + + JSF:JAVADOC:4821 + Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8. Jakarta Servlet: This must call through to the jakarta.servlet.ServletResponse method setCharacterEncoding(). The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4822 + Set the content length of the response. Jakarta Servlet: This must be performed by calling the jakarta.servlet.http.HttpServletResponse setContentLength method. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + int + + + + + + JSF:JAVADOC:4823 + Sets the content type of the response being sent to the client, if the response has not been committed yet. Jakarta Servlet: This must call setContentType() on the underlying jakarta.servlet.ServletResponse instance. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + java.lang.String + + + + + + JSF:JAVADOC:4824 + Set the response header with the given name and value. Jakarta Servlet:This must be performed by calling the jakarta.servlet.http.HttpServletResponse setHeader method. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:4825 + Sets the HTTP status code for the response. Jakarta Servlet: This must be performed by calling the jakarta.servlet.http.HttpServletResponse setStatus method. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + int + + + + + + JSF:JAVADOC:4826 + Specifies the time, in seconds, between client requests before the Jakarta Servlet container will invalidate this session. An interval value of zero or less indicates that the session should never timeout. Jakarta Servlet: This must call setMaxInactiveInterval on the underlying jakarta.servlet.http.HttpServletRequest instance. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + ExternalContext + + + int + + + + + + JSF:JAVADOC:4827 + + jakarta.faces.context + ExternalContextFactory + + + + + JSF:JAVADOC:4828 + If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.context + ExternalContextFactory + + + jakarta.faces.context.ExternalContextFactory + + + + + + JSF:JAVADOC:4829 + Create (if needed) and return an ExternalContext instance that is initialized for the processing of the specified request and response objects, for this web application. + jakarta.faces.context + ExternalContextFactory + + + java.lang.Object + java.lang.Object + java.lang.Object + + + + + + JSF:JAVADOC:4830 + if a ExternalContext cannot be constructed for the specified parameters + jakarta.faces.context + ExternalContextFactory + + + java.lang.Object + java.lang.Object + java.lang.Object + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:4831 + If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped. + jakarta.faces.context + ExternalContextFactory + + + + + JSF:JAVADOC:4832 + The default behavior of this method is to call ExternalContext#addResponseCookie(String, String, Map) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + java.lang.String + java.util.Map + + + + + + JSF:JAVADOC:4833 + The default behavior of this method is to call ExternalContext#addResponseHeader(String,String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:4834 + The default behavior of this method is to call ExternalContext#dispatch(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4835 + + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:4836 + The default behavior of this method is to call ExternalContext#encodeActionURL(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4837 + The default behavior of this method is to call jakarta.faces.context.ExternalContext#encodeBookmarkableURL(String, java.util.Map) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + java.util.Map + + + + + + JSF:JAVADOC:4838 + The default behavior of this method is to call ExternalContext#encodeNamespace(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4839 + The default behavior of this method is to call ExternalContext#encodePartialActionURL(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4840 + The default behavior of this method is to call jakarta.faces.context.ExternalContext#encodeRedirectURL(String, java.util.Map) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + java.util.Map + + + + + + JSF:JAVADOC:4841 + The default behavior of this method is to call ExternalContext#encodeResourceURL(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4842 + The default behavior of this method is to call ExternalContext#encodeWebsocketURL(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4843 + + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4844 + If this external context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.context + ExternalContextWrapper + + + jakarta.faces.context.ExternalContext + + + + + + JSF:JAVADOC:4845 + The default behavior of this method is to call ExternalContext#getApplicationContextPath on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4846 + The default behavior of this method is to call ExternalContext#getApplicationMap on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4847 + The default behavior of this method is to call ExternalContext#getAuthType on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4848 + The default behavior of this method is to call ExternalContext#getClientWindow on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4849 + The default behavior of this method is to call ExternalContext#getContext on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4850 + The default behavior of this method is to call ExternalContext#getContextName on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4851 + The default behavior of this method is to call ExternalContext#getFlash() on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4852 + The default behavior of this method is to call ExternalContext#getInitParameter(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4853 + The default behavior of this method is to call ExternalContext#getInitParameterMap on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4854 + The default behavior of this method is to call ExternalContext#getMimeType(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4855 + The default behavior of this method is to call ExternalContext#getRealPath(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4856 + The default behavior of this method is to call ExternalContext#getRemoteUser on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4857 + The default behavior of this method is to call ExternalContext#getRequest on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4858 + The default behavior of this method is to call ExternalContext#getRequestCharacterEncoding on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4859 + The default behavior of this method is to call ExternalContext#getRequestContentLength on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4860 + The default behavior of this method is to call ExternalContext#getRequestContentType on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4861 + The default behavior of this method is to call ExternalContext#getRequestContextPath on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4862 + The default behavior of this method is to call ExternalContext#getRequestCookieMap on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4863 + The default behavior of this method is to call ExternalContext#getRequestHeaderMap on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4864 + The default behavior of this method is to call ExternalContext#getRequestHeaderValuesMap on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4865 + The default behavior of this method is to call ExternalContext#getRequestLocale on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4866 + The default behavior of this method is to call ExternalContext#getRequestLocales on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4867 + The default behavior of this method is to call ExternalContext#getRequestMap on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4868 + The default behavior of this method is to call ExternalContext#getRequestParameterMap on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4869 + The default behavior of this method is to call ExternalContext#getRequestParameterNames on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4870 + The default behavior of this method is to call ExternalContext#getRequestParameterValuesMap on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4871 + The default behavior of this method is to call ExternalContext#getRequestPathInfo on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4872 + The default behavior of this method is to call ExternalContext#getRequestScheme on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4873 + The default behavior of this method is to call ExternalContext#getRequestServerName on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4874 + The default behavior of this method is to call ExternalContext#getRequestServerPort on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4875 + The default behavior of this method is to call ExternalContext#getRequestServletPath on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4876 + The default behavior of this method is to call ExternalContext#getResource(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4877 + + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + java.net.MalformedURLException + + + + + JSF:JAVADOC:4878 + The default behavior of this method is to call ExternalContext#getResourceAsStream(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4879 + The default behavior of this method is to call ExternalContext#getResourcePaths(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4880 + The default behavior of this method is to call ExternalContext#getResponse on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4881 + The default behavior of this method is to call ExternalContext#getResponseBufferSize() on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4882 + The default behavior of this method is to call ExternalContext#getResponseCharacterEncoding on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4883 + The default behavior of this method is to call ExternalContext#getResponseContentType on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4884 + The default behavior of this method is to call ExternalContext#getResponseOutputStream on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4885 + + jakarta.faces.context + ExternalContextWrapper + + java.io.IOException + + + + + JSF:JAVADOC:4886 + The default behavior of this method is to call ExternalContext#getResponseOutputWriter on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4887 + + jakarta.faces.context + ExternalContextWrapper + + java.io.IOException + + + + + JSF:JAVADOC:4888 + The default behavior of this method is to call ExternalContext#getSession(boolean) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + boolean + + + + + + JSF:JAVADOC:4889 + The default behavior of this method is to call ExternalContext#getSessionId(boolean) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + boolean + + + + + + JSF:JAVADOC:4890 + The default behavior of this method is to call ExternalContext#getSessionMap() on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4891 + The default behavior of this method is to call ExternalContext#getSessionMaxInactiveInterval() on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4892 + The default behavior of this method is to call ExternalContext#getUserPrincipal on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4893 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4894 + The default behavior of this method is to call ExternalContext#invalidateSession on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4895 + The default behavior of this method is to call ExternalContext#isResponseCommitted() on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4896 + The default behavior of this method is to call ExternalContext#isSecure on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4897 + The default behavior of this method is to call ExternalContext#isUserInRole(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4898 + The default behavior of this method is to call ExternalContext#log(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4899 + The default behavior of this method is to call ExternalContext#log(String, Throwable) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + java.lang.Throwable + + + + + + JSF:JAVADOC:4900 + The default behavior of this method is to call ExternalContext#redirect(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4901 + + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:4902 + The default behavior of this method is to call ExternalContext#release() on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4903 + The default behavior of this method is to call jakarta.faces.context.ExternalContext#responseFlushBuffer() on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4904 + + jakarta.faces.context + ExternalContextWrapper + + java.io.IOException + + + + + JSF:JAVADOC:4905 + The default behavior of this method is to call ExternalContext#responseReset() on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + + + JSF:JAVADOC:4906 + The default behavior of this method is to call ExternalContext#responseSendError(int,String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + int + java.lang.String + + + + + + JSF:JAVADOC:4907 + + jakarta.faces.context + ExternalContextWrapper + + + int + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:4908 + The default behavior of this method is to call ExternalContext#setClientWindow on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + jakarta.faces.lifecycle.ClientWindow + + + + + + JSF:JAVADOC:4909 + The default behavior of this method is to call ExternalContext#setRequest(Object) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.Object + + + + + + JSF:JAVADOC:4910 + The default behavior of this method is to call ExternalContext#setRequestCharacterEncoding(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4911 + + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + java.io.UnsupportedEncodingException + + + + + JSF:JAVADOC:4912 + The default behavior of this method is to call ExternalContext#setResponse(Object) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.Object + + + + + + JSF:JAVADOC:4913 + The default behavior of this method is to call ExternalContext#setResponseBufferSize(int) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + int + + + + + + JSF:JAVADOC:4914 + The default behavior of this method is to call ExternalContext#getResponseCharacterEncoding on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4915 + The default behavior of this method is to call jakarta.faces.context.ExternalContext#setResponseContentLength(int) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + int + + + + + + JSF:JAVADOC:4916 + The default behavior of this method is to call ExternalContext#setResponseContentType(String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4917 + The default behavior of this method is to call ExternalContext#setResponseHeader(String,String) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:4918 + The default behavior of this method is to call ExternalContext#setResponseStatus(int) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + int + + + + + + JSF:JAVADOC:4919 + The default behavior of this method is to call ExternalContext#setSessionMaxInactiveInterval(int) on the wrapped ExternalContext object. + jakarta.faces.context + ExternalContextWrapper + + + int + + + + + + JSF:JAVADOC:4920 + Append a jakarta.faces.application.FacesMessage to the set of messages associated with the specified client identifier, if clientId is not null. If clientId is null, this jakarta.faces.application.FacesMessage is assumed to not be associated with any specific component instance. + jakarta.faces.context + FacesContext + + + java.lang.String + jakarta.faces.application.FacesMessage + + + + + + JSF:JAVADOC:4921 + Return the Application instance associated with this web application. It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, returns the correct current jakarta.faces.application.Application instance. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4922 + Return a mutable Map representing the attributes associated wth this FacesContext instance. This Map is useful to store attributes that you want to go out of scope when the Faces lifecycle for the current request ends, which is not always the same as the request ending, especially in the case of Jakarta Servlet filters that are invoked after the Faces lifecycle for this request completes. Accessing this Map does not cause any events to fire, as is the case with the other maps: for request, session, and application scope. When #release() is invoked, the attributes must be cleared. The Map returned by this method is not associated with the request. If you would like to get or set request attributes, see ExternalContext#getRequestMap. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4923 + Return an Iterator over the client identifiers for which at least one jakarta.faces.application.FacesMessage has been queued. If there are no such client identifiers, an empty Iterator is returned. If any messages have been queued that were not associated with any specific client identifier, a null value will be included in the iterated values. The elements in the Iterator must be returned in the order in which they were added with #addMessage. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4924 + Return the value last set on this FacesContext instance when #setCurrentPhaseId was called. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4925 + Return the ELContext instance for this FacesContext instance. This ELContext instance has the same lifetime and scope as the FacesContext instance with which it is associated, and may be created lazily the first time this method is called for a given FacesContext instance. Upon creation of the ELContext instance, the implementation must take the following action: Call the ELContext#putContext method on the instance, passing in FacesContext.class and the this reference for the FacesContext instance itself. If the Collection returned by jakarta.faces.application.Application#getELContextListeners is non-empty, create an instance of jakarta.el.ELContextEvent and pass it to each jakarta.el.ELContextListener instance in the Collection by calling the jakarta.el.ELContextListener#contextCreated method. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4926 + Return the ExceptionHandler for this request. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4927 + Return the ExternalContext instance for this FacesContext instance. It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method returns an ExternalContext instance with the special behaviors indicated in the javadoc for that class. Methods document as being valid to call during application startup or shutdown must be supported. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4928 + Return the Lifecycle instance for this FacesContext instance. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4929 + Return the maximum severity level recorded on any jakarta.faces.application.FacesMessages that has been queued, whether or not they are associated with any specific jakarta.faces.component.UIComponent. If no such messages have been queued, return null. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4930 + Like #getMessages, but returns a List, enabling use from Jakarta Expression Language expressions. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4931 + Like #getMessages(java.lang.String), but returns a List of messages for the component with client id matching argument clientId. The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + FacesContext + + + java.lang.String + + + + + + JSF:JAVADOC:4932 + Return an Iterator over the jakarta.faces.application.FacesMessages that have been queued that are associated with the specified client identifier (if clientId is not null), or over the jakarta.faces.application.FacesMessages that have been queued that are not associated with any specific client identifier (if clientId is null). If no such messages have been queued, return an empty Iterator. The elements of the Iterator must be returned in the order in which they were added with calls to #addMessage. + jakarta.faces.context + FacesContext + + + java.lang.String + + + + + + JSF:JAVADOC:4933 + Return the result of calling UINamingContainer#getSeparatorChar, passing this as the argument. Note that this enables accessing the value of this property from the Jakarta Expression Language expression #{facesContext.namingContainerSeparatorChar}. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4934 + Return the PartialViewContext for this request. The PartialViewContext is used to control the processing of specified components during the execute portion of the request processing lifecycle (known as partial processing) and the rendering of specified components (known as partial rendering). This method must return a new PartialViewContext if one does not already exist. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4935 + Return the RenderKit instance for the render kit identifier specified on our UIViewRoot, if there is one. If there is no current UIViewRoot, if the UIViewRoot does not have a specified renderKitId, or if there is no RenderKit for the specified identifier, return null instead. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4936 + Return true if the renderResponse() method has been called for the current request. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4937 + Return the list of resource library contracts that have been calculated to be appropriate for use with this view, or an empty list if there are no such resource library contracts. The list returned by this method must be immutable. For backward compatibility with implementations of the specification prior to when this method was introduced, an implementation is provided that returns an empty list. Implementations compliant with the version in which this method was introduced must implement this method as specified. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4938 + Return true if the responseComplete() method has been called for the current request. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4939 + Return the root component that is associated with the this request. It is valid to call this method during application startup or shutdown. If called during application startup or shutdown, this method returns a new UIViewRoot with its locale set to Locale.getDefault(). + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4940 + This utility method simply returns the result of jakarta.faces.render.ResponseStateManager#isPostback(FacesContext). The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4941 + Returns a flag indicating whether or not the runtime should publish events when asked to do so. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4942 + Return true if the current ProjectStage as returned by the Application instance is equal to stage, otherwise return false + jakarta.faces.context + FacesContext + + + jakarta.faces.application.ProjectStage + + + + + + JSF:JAVADOC:4943 + Return a flag indicating if the resources associated with this FacesContext instance have been released. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4944 + Return true if the validationFailed() method has been called for the current request. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4945 + The implementation must call this method at the earliest possble point in time after entering into a new phase in the request processing lifecycle. + jakarta.faces.context + FacesContext + + + jakarta.faces.event.PhaseId + + + + + + JSF:JAVADOC:4946 + Set the ExceptionHandler for this request. + jakarta.faces.context + FacesContext + + + jakarta.faces.context.ExceptionHandler + + + + + + JSF:JAVADOC:4947 + Allows control of wheter or not the runtime will publish events when Application#publishEvent(FacesContext, Class, Object) or Application#publishEvent(FacesContext, Class, Class, Object) is called. + jakarta.faces.context + FacesContext + + + boolean + + + + + + JSF:JAVADOC:4948 + Set the resource library contracts calculated as valid to use with this view. The implementation must copy the contents of the incoming List into an immutable List for return from #getResourceLibraryContracts. If the argument is null or empty, the action taken is the same as if the argument is null: a subsequent call to getResourceLibraryContracts returns null. This method may only be called during the processing of jakarta.faces.view.ViewDeclarationLanguage#createView and during the VDL tag handler for the tag corresponding to an instance of UIViewRoot. For backward compatibility with implementations of the specification prior to when this method was introduced, an implementation is provided that takes no action. Implementations compliant with the version in which this method was introduced must implement this method as specified. + jakarta.faces.context + FacesContext + + + java.util.List + + + + + + JSF:JAVADOC:4949 + Set the root component that is associated with this request. This method can be called by the application handler (or a class that the handler calls), during the Invoke Application phase of the request processing lifecycle and during the Restore View phase of the request processing lifecycle (especially when a new root component is created). In the present version of the specification, implementations are not required to enforce this restriction, though a future version of the specification may require enforcement. If the current UIViewRoot is non-null, and calling equals() on the argument root, passing the current UIViewRoot returns false, the clear method must be called on the Map returned from UIViewRoot#getViewMap. + jakarta.faces.context + FacesContext + + + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:4950 + Sets a flag which indicates that a conversion or validation error occurred while processing the inputs. Inputs consist of either page parameters or form bindings. This flag can be read using #isValidationFailed. + jakarta.faces.context + FacesContext + + + + + JSF:JAVADOC:4951 + If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.context + FacesContextFactory + + + jakarta.faces.context.FacesContextFactory + + + + + + JSF:JAVADOC:4952 + Create (if needed) and return a FacesContext instance that is initialized for the processing of the specified request and response objects, utilizing the specified Lifecycle instance, for this web application. The implementation of this method must ensure that calls to the getCurrentInstance() method of FacesContext, from the same thread that called this method, will return the same FacesContext instance until the release() method is called on that instance. The implementation must call ExternalContextFactory#getExternalContext to produce the ExternalContext for the FacesContext instance. The default implementation must call ExceptionHandlerFactory#getExceptionHandler and make it so the return from that method is what gets returned from a call to FacesContext#getExceptionHandler on the returned FacesContext instance. The default implementation must call jakarta.faces.lifecycle.ClientWindowFactory#getClientWindow and make it so the return from that method is what gets returned from a call to ExternalContext#getClientWindow() on the returned ExternalContext instance. + jakarta.faces.context + FacesContextFactory + + + java.lang.Object + java.lang.Object + java.lang.Object + jakarta.faces.lifecycle.Lifecycle + + + + + + JSF:JAVADOC:4953 + if a FacesContext cannot be constructed for the specified parameters + jakarta.faces.context + FacesContextFactory + + + java.lang.Object + java.lang.Object + java.lang.Object + jakarta.faces.lifecycle.Lifecycle + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:4954 + If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped. + jakarta.faces.context + FacesContextFactory + + + + + JSF:JAVADOC:4955 + The default behavior of this method is to call FacesContext#addMessage(String, FacesMessage) on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + java.lang.String + jakarta.faces.application.FacesMessage + + + + + + JSF:JAVADOC:4956 + + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4957 + If this faces context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.context + FacesContextWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:4958 + The default behavior of this method is to call FacesContext#getApplication() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4959 + The default behavior of this method is to call FacesContext#getAttributes() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4960 + The default behavior of this method is to call jakarta.faces.context.FacesContext#getClientIdsWithMessages() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4961 + The default behavior of this method is to call FacesContext#getCurrentPhaseId() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4962 + The default behavior of this method is to call FacesContext#getELContext() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4963 + The default behavior of this method is to call FacesContext#getExceptionHandler() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4964 + The default behavior of this method is to call FacesContext#getExternalContext() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4965 + The default behavior of this method is to call FacesContext#getLifecycle() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4966 + The default behavior of this method is to call FacesContext#getMaximumSeverity() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4967 + The default behavior of this method is to call FacesContext#getMessageList() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4968 + The default behavior of this method is to call FacesContext#getMessageList(String) on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4969 + The default behavior of this method is to call FacesContext#getMessages() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4970 + The default behavior of this method is to call FacesContext#getMessages(String) on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:4971 + The default behavior of this method is to call FacesContext#getNamingContainerSeparatorChar() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4972 + The default behavior of this method is to call FacesContext#getPartialViewContext() ()} on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4973 + The default behavior of this method is to call FacesContext#getRenderKit() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4974 + The default behavior of this method is to call FacesContext#getRenderResponse() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4975 + The default behavior of this method is to call FacesContext#getResourceLibraryContracts on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4976 + The default behavior of this method is to call FacesContext#getResponseComplete() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4977 + The default behavior of this method is to call FacesContext#getResponseStream() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4978 + The default behavior of this method is to call FacesContext#getResponseWriter() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4979 + The default behavior of this method is to call FacesContext#getViewRoot() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4980 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4981 + The default behavior of this method is to call FacesContext#isPostback() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4982 + The default behavior of this method is to call jakarta.faces.context.FacesContext#isProcessingEvents() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4983 + The default behavior of this method is to call jakarta.faces.context.FacesContext#isProjectStage(jakarta.faces.application.ProjectStage) on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + jakarta.faces.application.ProjectStage + + + + + + JSF:JAVADOC:4984 + The default behavior of this method is to call FacesContext#isReleased on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4985 + The default behavior of this method is to call jakarta.faces.context.FacesContext#isValidationFailed on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4986 + The default behavior of this method is to call FacesContext#release() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4987 + The default behavior of this method is to call FacesContext#renderResponse() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4988 + The default behavior of this method is to call FacesContext#responseComplete() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4989 + The default behavior of this method is to call FacesContext#setCurrentPhaseId(PhaseId) on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + jakarta.faces.event.PhaseId + + + + + + JSF:JAVADOC:4990 + The default behavior of this method is to call FacesContext#setExceptionHandler(ExceptionHandler) on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + jakarta.faces.context.ExceptionHandler + + + + + + JSF:JAVADOC:4991 + The default behavior of this method is to call FacesContext#setProcessingEvents(boolean) on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + boolean + + + + + + JSF:JAVADOC:4992 + The default behavior of this method is to call FacesContext#setResourceLibraryContracts on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + java.util.List + + + + + + JSF:JAVADOC:4993 + The default behavior of this method is to call FacesContext#setResponseStream(ResponseStream) on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + jakarta.faces.context.ResponseStream + + + + + + JSF:JAVADOC:4994 + The default behavior of this method is to call FacesContext#setResponseWriter(ResponseWriter) on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + jakarta.faces.context.ResponseWriter + + + + + + JSF:JAVADOC:4995 + The default behavior of this method is to call FacesContext#setViewRoot(UIViewRoot) on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:4996 + The default behavior of this method is to call jakarta.faces.context.FacesContext#validationFailed() on the wrapped FacesContext object. + jakarta.faces.context + FacesContextWrapper + + + + + JSF:JAVADOC:4997 + Called after the execution of every lifecycle phase, this method allows implementations to take the necessary actions to provide the Flash scope contract as it applies to the request procesing lifecycle. + jakarta.faces.context + Flash + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:4998 + Called before the execution of every lifecycle phase, this method allows implementations to take the necessary actions to provide the Flash scope contract as it applies to the request procesing lifecycle. + jakarta.faces.context + Flash + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:4999 + + jakarta.faces.context + Flash + + + + + JSF:JAVADOC:5000 + Return the value of this JavaBeans property for the flash for this session. This value determines whether or not any jakarta.faces.application.FacesMessage instances queued in the current jakarta.faces.context.FacesContext must be preserved so they are accessible on the next traversal of the lifecycle on this session, regardless of the request being a redirect after post, or a normal postback. Map accesses for the special key #8220;keepMessages #8221; must return the value of this JavaBeans property. Jakarta Expression Language Usage Example First page Next page Any messages present on the first page must be displayed on this page. + jakarta.faces.context + Flash + + + + + JSF:JAVADOC:5001 + Return the value of this property for the flash for this session. This must be false unless: #setRedirect was called for the current lifecycle traversal with true as the argument. The current lifecycle traversal for this session is in the #8220;execute #8221; phase and the previous traversal had #setRedirect called with true as the argument. + jakarta.faces.context + Flash + + + + + JSF:JAVADOC:5002 + Causes a value stored with a previous call to #putNow, its Jakarta Expression Language equivalent, or to the request Map, to be promoted to the flash so that is available on the next traversal through the lifecycle on this session. + jakarta.faces.context + Flash + + + java.lang.String + + + + + + JSF:JAVADOC:5003 + Puts a value in the flash so that it can be accessed on this traversal of the lifecycle, rather than on the next traversal. This is simply an alias for putting a value in the request map. Jakarta Expression Language Usage Example Value of \#{flash.now.bar}, should be barValue. + jakarta.faces.context + Flash + + + java.lang.String + java.lang.Object + + + + + + JSF:JAVADOC:5004 + Setter for keepMessages JavaBeans property. See #isKeepMessages. + jakarta.faces.context + Flash + + + boolean + + + + + + JSF:JAVADOC:5005 + Setting this property to true indicates that the next request on this session will be a redirect. Recall that on a redirect, the server sends a special response to the client instructing it to issue a new request to a specific URI. The implementation must insure that reading the value of this property on that request will return true. Jakarta Expression Language Usage Example + jakarta.faces.context + Flash + + + boolean + + + + + + JSF:JAVADOC:5006 + + jakarta.faces.context + FlashFactory + + + + + JSF:JAVADOC:5007 + If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.context + FlashFactory + + + jakarta.faces.context.FlashFactory + + + + + + JSF:JAVADOC:5008 + Create (if needed) and return a Flash instance for this web application. + jakarta.faces.context + FlashFactory + + + boolean + + + + + + JSF:JAVADOC:5009 + If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped. + jakarta.faces.context + FlashFactory + + + + + JSF:JAVADOC:5010 + The default behavior of this method is to call Flash#clear() on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + + + JSF:JAVADOC:5011 + The default behavior of this method is to call Flash#containsKey(Object) on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + java.lang.Object + + + + + + JSF:JAVADOC:5012 + The default behavior of this method is to call Flash#containsValue(Object) on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + java.lang.Object + + + + + + JSF:JAVADOC:5013 + The default behavior of this method is to call Flash#doPostPhaseActions(FacesContext) on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5014 + The default behavior of this method is to call Flash#doPrePhaseActions(FacesContext) on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5015 + The default behavior of this method is to call Flash#entrySet() on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + + + JSF:JAVADOC:5016 + + jakarta.faces.context + FlashWrapper + + + + + JSF:JAVADOC:5017 + If this flash has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.context + FlashWrapper + + + jakarta.faces.context.Flash + + + + + + JSF:JAVADOC:5018 + The default behavior of this method is to call Flash#get(Object) on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + java.lang.Object + + + + + + JSF:JAVADOC:5019 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.context + FlashWrapper + + + + + JSF:JAVADOC:5020 + The default behavior of this method is to call Flash#isEmpty() on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + + + JSF:JAVADOC:5021 + The default behavior of this method is to call Flash#isKeepMessages() on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + + + JSF:JAVADOC:5022 + The default behavior of this method is to call Flash#isRedirect() on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + + + JSF:JAVADOC:5023 + The default behavior of this method is to call Flash#keep(String) on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:5024 + The default behavior of this method is to call Flash#keySet() on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + + + JSF:JAVADOC:5025 + The default behavior of this method is to call Flash#put on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + java.lang.String + java.lang.Object + + + + + + JSF:JAVADOC:5026 + The default behavior of this method is to call Flash#putAll(Map) on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + java.util.Map + + + + + + JSF:JAVADOC:5027 + The default behavior of this method is to call Flash#putNow(String, Object) on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + java.lang.String + java.lang.Object + + + + + + JSF:JAVADOC:5028 + The default behavior of this method is to call Flash#remove(Object) on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + java.lang.Object + + + + + + JSF:JAVADOC:5029 + The default behavior of this method is to call Flash#setKeepMessages(boolean) on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + boolean + + + + + + JSF:JAVADOC:5030 + The default behavior of this method is to call Flash#setRedirect(boolean) on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + boolean + + + + + + JSF:JAVADOC:5031 + The default behavior of this method is to call Flash#size() on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + + + JSF:JAVADOC:5032 + The default behavior of this method is to call Flash#values() on the wrapped Flash object. + jakarta.faces.context + FlashWrapper + + + + + JSF:JAVADOC:5033 + Write a delete operation. + jakarta.faces.context + PartialResponseWriter + + + java.lang.String + + + + + + JSF:JAVADOC:5034 + if an input/output error occurs + jakarta.faces.context + PartialResponseWriter + + + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5035 + Write the end of a partial response. + jakarta.faces.context + PartialResponseWriter + + + + + JSF:JAVADOC:5036 + if an input/output error occurs + jakarta.faces.context + PartialResponseWriter + + java.io.IOException + + + + + JSF:JAVADOC:5037 + Write the end of an error. + jakarta.faces.context + PartialResponseWriter + + + + + JSF:JAVADOC:5038 + if an input/output error occurs + jakarta.faces.context + PartialResponseWriter + + java.io.IOException + + + + + JSF:JAVADOC:5039 + Write the end of an eval operation. + jakarta.faces.context + PartialResponseWriter + + + + + JSF:JAVADOC:5040 + if an input/output error occurs + jakarta.faces.context + PartialResponseWriter + + java.io.IOException + + + + + JSF:JAVADOC:5041 + Write the end of an extension operation. + jakarta.faces.context + PartialResponseWriter + + + + + JSF:JAVADOC:5042 + if an input/output error occurs + jakarta.faces.context + PartialResponseWriter + + java.io.IOException + + + + + JSF:JAVADOC:5043 + Write the end of an insert operation. + jakarta.faces.context + PartialResponseWriter + + + + + JSF:JAVADOC:5044 + if an input/output error occurs + jakarta.faces.context + PartialResponseWriter + + java.io.IOException + + + + + JSF:JAVADOC:5045 + Write the end of an update operation. + jakarta.faces.context + PartialResponseWriter + + + + + JSF:JAVADOC:5046 + if an input/output error occurs + jakarta.faces.context + PartialResponseWriter + + java.io.IOException + + + + + JSF:JAVADOC:5047 + Create a PartialResponseWriter. + jakarta.faces.context + PartialResponseWriter + + + jakarta.faces.context.ResponseWriter + + + + + + JSF:JAVADOC:5048 + Write a redirect operation. + jakarta.faces.context + PartialResponseWriter + + + java.lang.String + + + + + + JSF:JAVADOC:5049 + if an input/output error occurs + jakarta.faces.context + PartialResponseWriter + + + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5050 + Write the start of a partial response. If UIViewRoot is an instance of NamingContainer, then write UIViewRoot#getContainerClientId(FacesContext) as value of the id attribute of the root element. + jakarta.faces.context + PartialResponseWriter + + + + + JSF:JAVADOC:5051 + if an input/output error occurs + jakarta.faces.context + PartialResponseWriter + + java.io.IOException + + + + + JSF:JAVADOC:5052 + Write the start of an error. + jakarta.faces.context + PartialResponseWriter + + + java.lang.String + + + + + + JSF:JAVADOC:5053 + if an input/output error occurs + jakarta.faces.context + PartialResponseWriter + + + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5054 + Write the start of an eval operation. + jakarta.faces.context + PartialResponseWriter + + + + + JSF:JAVADOC:5055 + if an input/output error occurs + jakarta.faces.context + PartialResponseWriter + + java.io.IOException + + + + + JSF:JAVADOC:5056 + Write the start of an extension operation. + jakarta.faces.context + PartialResponseWriter + + + java.util.Map + + + + + + JSF:JAVADOC:5057 + if an input/output error occurs + jakarta.faces.context + PartialResponseWriter + + + java.util.Map + + java.io.IOException + + + + + JSF:JAVADOC:5058 + Write the start of an insert operation where the contents will be inserted after the specified target node. + jakarta.faces.context + PartialResponseWriter + + + java.lang.String + + + + + + JSF:JAVADOC:5059 + if an input/output error occurs + jakarta.faces.context + PartialResponseWriter + + + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5060 + Write the start of an insert operation where the contents will be inserted before the specified target node. + jakarta.faces.context + PartialResponseWriter + + + java.lang.String + + + + + + JSF:JAVADOC:5061 + if an input/output error occurs + jakarta.faces.context + PartialResponseWriter + + + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5062 + Write the start of an update operation. + jakarta.faces.context + PartialResponseWriter + + + java.lang.String + + + + + + JSF:JAVADOC:5063 + if an input/output error occurs + jakarta.faces.context + PartialResponseWriter + + + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5064 + Write an attribute update operation. + jakarta.faces.context + PartialResponseWriter + + + java.lang.String + java.util.Map + + + + + + JSF:JAVADOC:5065 + if an input/output error occurs + jakarta.faces.context + PartialResponseWriter + + + java.lang.String + java.util.Map + + java.io.IOException + + + + + JSF:JAVADOC:5066 + Returns a mutable List of scripts to be evaluated in client side on complete of ajax request. + jakarta.faces.context + PartialViewContext + + + + + JSF:JAVADOC:5067 + Return a Collection of client identifiers from the current request with the request parameter name #PARTIAL_EXECUTE_PARAM_NAME. If there is no such request parameter, return an empty Collection. These client identifiers are used to identify components that will be processed during the execute phase of the request processing lifecycle. The returned Collection is mutable. + jakarta.faces.context + PartialViewContext + + + + + JSF:JAVADOC:5068 + Return the ResponseWriter to which components should direct their output for partial view rendering. Within a given response, components can use either the ResponseStream or the ResponseWriter, but not both. + jakarta.faces.context + PartialViewContext + + + + + JSF:JAVADOC:5069 + Return a Collection of client identifiers from the current request with the request parameter name #PARTIAL_RENDER_PARAM_NAME. If there is no such request parameter, return an empty Collection. These client identifiers are used to identify components that will be processed during the render phase of the request processing lifecycle. The returned Collection is mutable. + jakarta.faces.context + PartialViewContext + + + + + JSF:JAVADOC:5070 + Return true if the request header Faces-Request is present with the value partial/ajax. Otherwise, return false. + jakarta.faces.context + PartialViewContext + + + + + JSF:JAVADOC:5071 + Return true if #isAjaxRequest returns true and #PARTIAL_EXECUTE_PARAM_NAME is present in the current request with the value #ALL_PARTIAL_PHASE_CLIENT_IDS. Otherwise, return false. + jakarta.faces.context + PartialViewContext + + + + + JSF:JAVADOC:5072 + Return true #isAjaxRequest returns true or if the request header Faces-Request is present with the value partial/process. Otherwise, return false. + jakarta.faces.context + PartialViewContext + + + + + JSF:JAVADOC:5073 + Return true if #isAjaxRequest returns true and #PARTIAL_RENDER_PARAM_NAME is present in the current request with the value #ALL_PARTIAL_PHASE_CLIENT_IDS. Otherwise, return false. + jakarta.faces.context + PartialViewContext + + + + + JSF:JAVADOC:5074 + Return true if the incoming request has a parameter named by the value of #RESET_VALUES_PARAM_NAME and that value is true. To preserve backward compatibility with custom implementations that may have extended from an earlier version of this class, an implementation is provided that returns false. A compliant implementation must override this method to take the specified action. + jakarta.faces.context + PartialViewContext + + + + + JSF:JAVADOC:5075 + + jakarta.faces.context + PartialViewContext + + + + + JSF:JAVADOC:5076 + Perform lifecycle processing on components during the indicated phaseId. Only those components with identifiers existing in the Collection returned from #getExecuteIds and #getRenderIds will be processed. When the indicated phaseId equals PhaseId#RENDER_RESPONSE, then perform the following tasks in sequence: If #isResetValues() returns true, then call UIViewRoot#resetValues(FacesContext, Collection), passing #getRenderIds(). If #isRenderAll() returns false, then render any component resource of UIViewRoot whose ResourceHandler#getRendererTypeForResourceName(String) does not return null, and whose UIComponent#getChildCount() is zero, and whose ResourceHandler#isResourceRendered(FacesContext, String, String) returns false, in an update element with an identifier of jakarta.faces.Resource. Process the components. Obtain the state by calling StateManager#getViewState and write it out as an update element with an identifier of jakarta.faces.ViewState where is the return from UIViewRoot#getContainerClientId(FacesContext) on the view from whence this state originated, and is the currently configured UINamingContainer#getSeparatorChar(FacesContext). If #isRenderAll() returns false, then write out each script of #getEvalScripts() as an eval element. + jakarta.faces.context + PartialViewContext + + + jakarta.faces.event.PhaseId + + + + + + JSF:JAVADOC:5077 + Release any resources associated with this PartialViewContext instance. + jakarta.faces.context + PartialViewContext + + + + + JSF:JAVADOC:5078 + Dynamically indicate that this is a partial request. + jakarta.faces.context + PartialViewContext + + + boolean + + + + + + JSF:JAVADOC:5079 + Indicate the entire view must be rendered if renderAll is true. + jakarta.faces.context + PartialViewContext + + + boolean + + + + + + JSF:JAVADOC:5080 + Create (if needed) and return a PartialViewContext instance that is initialized using the current FacesContext instance. + jakarta.faces.context + PartialViewContextFactory + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5081 + If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped. + jakarta.faces.context + PartialViewContextFactory + + + + + JSF:JAVADOC:5082 + + jakarta.faces.context + PartialViewContextFactory + + + + + JSF:JAVADOC:5083 + If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.context + PartialViewContextFactory + + + jakarta.faces.context.PartialViewContextFactory + + + + + + JSF:JAVADOC:5084 + The default behavior of this method is to call PartialViewContext#getRenderIds() on the wrapped PartialViewContext object. + jakarta.faces.context + PartialViewContextWrapper + + + + + JSF:JAVADOC:5085 + The default behavior of this method is to call PartialViewContext#getExecuteIds() on the wrapped PartialViewContext object. + jakarta.faces.context + PartialViewContextWrapper + + + + + JSF:JAVADOC:5086 + The default behavior of this method is to call PartialViewContext#getPartialResponseWriter() on the wrapped PartialViewContext object. + jakarta.faces.context + PartialViewContextWrapper + + + + + JSF:JAVADOC:5087 + The default behavior of this method is to call PartialViewContext#getRenderIds() on the wrapped PartialViewContext object. + jakarta.faces.context + PartialViewContextWrapper + + + + + JSF:JAVADOC:5088 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.context + PartialViewContextWrapper + + + + + JSF:JAVADOC:5089 + The default behavior of this method is to call PartialViewContext#isAjaxRequest() on the wrapped PartialViewContext object. + jakarta.faces.context + PartialViewContextWrapper + + + + + JSF:JAVADOC:5090 + The default behavior of this method is to call PartialViewContext#isExecuteAll() on the wrapped PartialViewContext object. + jakarta.faces.context + PartialViewContextWrapper + + + + + JSF:JAVADOC:5091 + The default behavior of this method is to call PartialViewContext#isPartialRequest() on the wrapped PartialViewContext object. + jakarta.faces.context + PartialViewContextWrapper + + + + + JSF:JAVADOC:5092 + The default behavior of this method is to call PartialViewContext#isRenderAll() on the wrapped PartialViewContext object. + jakarta.faces.context + PartialViewContextWrapper + + + + + JSF:JAVADOC:5093 + The default behavior of this method is to call PartialViewContext#isResetValues() on the wrapped PartialViewContext object. + jakarta.faces.context + PartialViewContextWrapper + + + + + JSF:JAVADOC:5094 + + jakarta.faces.context + PartialViewContextWrapper + + + + + JSF:JAVADOC:5095 + If this partial view context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.context + PartialViewContextWrapper + + + jakarta.faces.context.PartialViewContext + + + + + + JSF:JAVADOC:5096 + The default behavior of this method is to call PartialViewContext#processPartial(PhaseId) on the wrapped PartialViewContext object. + jakarta.faces.context + PartialViewContextWrapper + + + jakarta.faces.event.PhaseId + + + + + + JSF:JAVADOC:5097 + The default behavior of this method is to call PartialViewContext#release() on the wrapped PartialViewContext object. + jakarta.faces.context + PartialViewContextWrapper + + + + + JSF:JAVADOC:5098 + The default behavior of this method is to call PartialViewContext#setPartialRequest(boolean) on the wrapped PartialViewContext object. + jakarta.faces.context + PartialViewContextWrapper + + + boolean + + + + + + JSF:JAVADOC:5099 + The default behavior of this method is to call PartialViewContext#setRenderAll(boolean) on the wrapped PartialViewContext object. + jakarta.faces.context + PartialViewContextWrapper + + + boolean + + + + + + JSF:JAVADOC:5100 + Create and return a new instance of this ResponseWriter, using the specified Writer as the output destination. + jakarta.faces.context + ResponseWriter + + + java.io.Writer + + + + + + JSF:JAVADOC:5101 + Close an XML CDATA block. The default implementation of this method takes no action when invoked. + jakarta.faces.context + ResponseWriter + + + + + JSF:JAVADOC:5102 + if input/output error occures + jakarta.faces.context + ResponseWriter + + java.io.IOException + + + + + JSF:JAVADOC:5103 + Flush any ouput buffered by the output method to the underlying Writer or OutputStream. This method will not flush the underlying Writer or OutputStream; it simply clears any values buffered by this ResponseWriter. + jakarta.faces.context + ResponseWriter + + + + + JSF:JAVADOC:5104 + + jakarta.faces.context + ResponseWriter + + java.io.IOException + + + + + JSF:JAVADOC:5105 + Return the character encoding (such as "ISO-8859-1") for this ResponseWriter. Please see the IANA for a list of character encodings. + jakarta.faces.context + ResponseWriter + + + + + JSF:JAVADOC:5106 + Return the content type (such as "text/html") for this ResponseWriter. Note: this must not include the "charset=" suffix. + jakarta.faces.context + ResponseWriter + + + + + JSF:JAVADOC:5107 + Open an XML CDATA block. Note that XML does not allow nested CDATA blocks, though this method does not enforce that constraint. The default implementation of this method takes no action when invoked. + jakarta.faces.context + ResponseWriter + + + + + JSF:JAVADOC:5108 + if input/output error occures + jakarta.faces.context + ResponseWriter + + java.io.IOException + + + + + JSF:JAVADOC:5109 + Write the start of an element, up to and including the element name. Once this method has been called, clients can call the writeAttribute() or writeURIAttribute() methods to add attributes and corresponding values. The starting element will be closed (that is, the trailing ' gt;' character added) on any subsequent call to startElement(), writeComment(), writeText(), endElement(), endDocument(), close(), flush(), or write(). If the argument component's pass through attributes includes an attribute of the name given by the value of the symbolic constant jakarta.faces.render.Renderer#PASSTHROUGH_RENDERER_LOCALNAME_KEY, use that as the element name, instead of the value passed as the first parameter to this method. Care must be taken so that this value is not also rendered when any other pass through attributes on this component are rendered. + jakarta.faces.context + ResponseWriter + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5110 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + + java.lang.String + jakarta.faces.component.UIComponent + + java.io.IOException + + + + + JSF:JAVADOC:5111 + Write an attribute name and corresponding value, after converting that text to a String (if necessary), and after performing any escaping appropriate for the markup language being rendered. This method may only be called after a call to startElement(), and before the opened element has been closed. + jakarta.faces.context + ResponseWriter + + + java.lang.String + java.lang.Object + java.lang.String + + + + + + JSF:JAVADOC:5112 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + + java.lang.String + java.lang.Object + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5113 + Write a string containing the markup specific doctype. No escaping is performed. The default implementation simply calls through to #write(java.lang.String) . The implementation makes no checks if this is the correct place in the response to have a doctype, nor does it prevent the doctype from being written more than once. + jakarta.faces.context + ResponseWriter + + + java.lang.String + + + + + + JSF:JAVADOC:5114 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5115 + Write a string containing the markup specific preamble. No escaping is performed. The default implementation simply calls through to #write(java.lang.String) . The implementation makes no checks if this is the correct place in the response to have a preamble, nor does it prevent the preamble from being written more than once. + jakarta.faces.context + ResponseWriter + + + java.lang.String + + + + + + JSF:JAVADOC:5116 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5117 + Write an object, after converting it to a String (if necessary), and after performing any escaping appropriate for the markup language being rendered. If there is an open element that has been created by a call to startElement(), that element will be closed first. + jakarta.faces.context + ResponseWriter + + + java.lang.Object + java.lang.String + + + + + + JSF:JAVADOC:5118 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + + java.lang.Object + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5119 + Write an object, after converting it to a String (if necessary), and after performing any escaping appropriate for the markup language being rendered. This method is equivalent to #writeText(java.lang.Object,java.lang.String) but adds a component property to allow custom ResponseWriter implementations to associate a component with an arbitrary portion of text. The default implementation simply ignores the component argument and calls through to #writeText(java.lang.Object,java.lang.String) + jakarta.faces.context + ResponseWriter + + + java.lang.Object + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:5120 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + + java.lang.Object + jakarta.faces.component.UIComponent + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5121 + Write a URI attribute name and corresponding value, after converting that text to a String (if necessary), and after performing any encoding or escaping appropriate to the markup language being rendered. When rendering in a WWW environment, the escaping conventions established in the W3C URI spec document must be followed. In particular, spaces ' ' must be encoded as %20 and not the plus character '+'. This method may only be called after a call to startElement(), and before the opened element has been closed. + jakarta.faces.context + ResponseWriter + + + java.lang.String + java.lang.Object + java.lang.String + + + + + + JSF:JAVADOC:5122 + if an input/output error occurs + jakarta.faces.context + ResponseWriter + + + java.lang.String + java.lang.Object + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5123 + The default behavior of this method is to call ResponseWriter#cloneWithWriter(java.io.Writer) on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + java.io.Writer + + + + + + JSF:JAVADOC:5124 + The default behavior of this method is to call ResponseWriter#close() on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + + + JSF:JAVADOC:5125 + + jakarta.faces.context + ResponseWriterWrapper + + java.io.IOException + + + + + JSF:JAVADOC:5126 + The default behavior of this method is to call ResponseWriter#endCDATA on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + + + JSF:JAVADOC:5127 + on any read/write error + jakarta.faces.context + ResponseWriterWrapper + + java.io.IOException + + + + + JSF:JAVADOC:5128 + The default behavior of this method is to call ResponseWriter#endDocument() on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + + + JSF:JAVADOC:5129 + + jakarta.faces.context + ResponseWriterWrapper + + java.io.IOException + + + + + JSF:JAVADOC:5130 + The default behavior of this method is to call ResponseWriter#endElement(String) on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:5131 + on any read/write error + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5132 + The default behavior of this method is to call ResponseWriter#flush() on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + + + JSF:JAVADOC:5133 + + jakarta.faces.context + ResponseWriterWrapper + + java.io.IOException + + + + + JSF:JAVADOC:5134 + The default behavior of this method is to call ResponseWriter#getCharacterEncoding() on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + + + JSF:JAVADOC:5135 + The default behavior of this method is to call ResponseWriter#getContentType() on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + + + JSF:JAVADOC:5136 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.context + ResponseWriterWrapper + + + + + JSF:JAVADOC:5137 + + jakarta.faces.context + ResponseWriterWrapper + + + + + JSF:JAVADOC:5138 + If this response writer has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.context + ResponseWriterWrapper + + + jakarta.faces.context.ResponseWriter + + + + + + JSF:JAVADOC:5139 + The default behavior of this method is to call ResponseWriter#startCDATA on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + + + JSF:JAVADOC:5140 + on any read/write error + jakarta.faces.context + ResponseWriterWrapper + + java.io.IOException + + + + + JSF:JAVADOC:5141 + The default behavior of this method is to call ResponseWriter#startDocument() on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + + + JSF:JAVADOC:5142 + + jakarta.faces.context + ResponseWriterWrapper + + java.io.IOException + + + + + JSF:JAVADOC:5143 + The default behavior of this method is to call ResponseWriter#startElement(String, jakarta.faces.component.UIComponent) on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.String + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5144 + + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.String + jakarta.faces.component.UIComponent + + java.io.IOException + + + + + JSF:JAVADOC:5145 + The default behavior of this method is to call ResponseWriter#write(char[], int, int) on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + char[] + int + int + + + + + + JSF:JAVADOC:5146 + + jakarta.faces.context + ResponseWriterWrapper + + + char[] + int + int + + java.io.IOException + + + + + JSF:JAVADOC:5147 + The default behavior of this method is to call ResponseWriter#writeAttribute(String, Object, String) on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.String + java.lang.Object + java.lang.String + + + + + + JSF:JAVADOC:5148 + + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.String + java.lang.Object + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5149 + The default behavior of this method is to call ResponseWriter#writeComment(Object) on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.Object + + + + + + JSF:JAVADOC:5150 + + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.Object + + java.io.IOException + + + + + JSF:JAVADOC:5151 + The default behavior of this method is to call ResponseWriter#writeDoctype on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:5152 + + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5153 + The default behavior of this method is to call ResponseWriter#writePreamble on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:5154 + + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5155 + The default behavior of this method is to call ResponseWriter#writeText(Object, String) on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.Object + java.lang.String + + + + + + JSF:JAVADOC:5156 + + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.Object + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5157 + The default behavior of this method is to call ResponseWriter#writeText(Object, UIComponent, String) on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.Object + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:5158 + + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.Object + jakarta.faces.component.UIComponent + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5159 + The default behavior of this method is to call ResponseWriter#writeText(char[], int, int) on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + char[] + int + int + + + + + + JSF:JAVADOC:5160 + + jakarta.faces.context + ResponseWriterWrapper + + + char[] + int + int + + java.io.IOException + + + + + JSF:JAVADOC:5161 + The default behavior of this method is to call ResponseWriter#writeURIAttribute(String, Object, String) on the wrapped ResponseWriter object. + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.String + java.lang.Object + java.lang.String + + + + + + JSF:JAVADOC:5162 + + jakarta.faces.context + ResponseWriterWrapper + + + java.lang.String + java.lang.Object + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5163 + + jakarta.faces.convert + BigDecimalConverter + + + + + JSF:JAVADOC:5164 + Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle. + jakarta.faces.convert + BigDecimalConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:5165 + + jakarta.faces.convert + BigDecimalConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5166 + + jakarta.faces.convert + BigIntegerConverter + + + + + JSF:JAVADOC:5167 + Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle. + jakarta.faces.convert + BigIntegerConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:5168 + + jakarta.faces.convert + BigIntegerConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5169 + + jakarta.faces.convert + BooleanConverter + + + + + JSF:JAVADOC:5170 + Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle. + jakarta.faces.convert + BooleanConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:5171 + + jakarta.faces.convert + BooleanConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5172 + + jakarta.faces.convert + ByteConverter + + + + + JSF:JAVADOC:5173 + Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle. + jakarta.faces.convert + ByteConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:5174 + + jakarta.faces.convert + ByteConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5175 + + jakarta.faces.convert + CharacterConverter + + + + + JSF:JAVADOC:5176 + Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle. + jakarta.faces.convert + CharacterConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:5177 + + jakarta.faces.convert + CharacterConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5178 + Construct a new exception with the specified detail message and no root cause. + jakarta.faces.convert + ConverterException + + + jakarta.faces.application.FacesMessage + + + + + + JSF:JAVADOC:5179 + Construct a new exception with the specified detail message and root cause. + jakarta.faces.convert + ConverterException + + + jakarta.faces.application.FacesMessage + java.lang.Throwable + + + + + + JSF:JAVADOC:5180 + Returns the FacesMessage associated with this exception; this will only be available if the converter that thew this exception instance placed it there. + jakarta.faces.convert + ConverterException + + + + + JSF:JAVADOC:5181 + Reset the PartialStateHolder to a non-delta tracking state. + jakarta.faces.convert + DateTimeConverter + + + + + JSF:JAVADOC:5182 + + jakarta.faces.convert + DateTimeConverter + + + + + JSF:JAVADOC:5183 + Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle. + jakarta.faces.convert + DateTimeConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:5184 + + jakarta.faces.convert + DateTimeConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5185 + Return the style to be used to format or parse dates. If not set, the default value, default, is returned. + jakarta.faces.convert + DateTimeConverter + + + + + JSF:JAVADOC:5186 + Return the Locale to be used when parsing or formatting dates and times. If not explicitly set, the Locale stored in the jakarta.faces.component.UIViewRoot for the current request is returned. + jakarta.faces.convert + DateTimeConverter + + + + + JSF:JAVADOC:5187 + Return the format pattern to be used when formatting and parsing dates and times. + jakarta.faces.convert + DateTimeConverter + + + + + JSF:JAVADOC:5188 + Return the style to be used to format or parse times. If not set, the default value, default, is returned. + jakarta.faces.convert + DateTimeConverter + + + + + JSF:JAVADOC:5189 + Return the TimeZone used to interpret a time value. If not explicitly set, the default time zone of GMT returned. + jakarta.faces.convert + DateTimeConverter + + + + + JSF:JAVADOC:5190 + Return the type of value to be formatted or parsed. If not explicitly set, the default type, date is returned. + jakarta.faces.convert + DateTimeConverter + + + + + JSF:JAVADOC:5191 + Return true if delta state changes are being tracked, otherwise false + jakarta.faces.convert + DateTimeConverter + + + + + JSF:JAVADOC:5192 + + jakarta.faces.convert + DateTimeConverter + + + + + JSF:JAVADOC:5193 + The runtime must ensure that the #markInitialState method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state. The implementor of the interface must ensure that #initialStateMarked returns true from the time markInitialState() is called until #clearInitialState is called, after which time initialStateMarked() must return false. Also, during the time that the instance returns true from initialStateMarked(), the implementation must return only the state that has changed in its implementation of StateHolder#saveState. + jakarta.faces.convert + DateTimeConverter + + + + + JSF:JAVADOC:5194 + + jakarta.faces.convert + DateTimeConverter + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:5195 + + jakarta.faces.convert + DateTimeConverter + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5196 + Set the style to be used to format or parse dates. Valid values are default, short, medium, long, and full. An invalid value will cause a ConverterException when getAsObject() or getAsString() is called. + jakarta.faces.convert + DateTimeConverter + + + java.lang.String + + + + + + JSF:JAVADOC:5197 + Set the Locale to be used when parsing or formatting dates and times. If set to null, the Locale stored in the jakarta.faces.component.UIViewRoot for the current request will be utilized. + jakarta.faces.convert + DateTimeConverter + + + java.util.Locale + + + + + + JSF:JAVADOC:5198 + Set the format pattern to be used when formatting and parsing dates and times. Valid values are those supported by java.text.SimpleDateFormat. An invalid value will cause a ConverterException when getAsObject() or getAsString() is called. + jakarta.faces.convert + DateTimeConverter + + + java.lang.String + + + + + + JSF:JAVADOC:5199 + Set the style to be used to format or parse times. Valid values are default, short, medium, long, and full. An invalid value will cause a ConverterException when getAsObject() or getAsString() is called. + jakarta.faces.convert + DateTimeConverter + + + java.lang.String + + + + + + JSF:JAVADOC:5200 + Set the TimeZone used to interpret a time value. + jakarta.faces.convert + DateTimeConverter + + + java.util.TimeZone + + + + + + JSF:JAVADOC:5201 + + jakarta.faces.convert + DateTimeConverter + + + boolean + + + + + + JSF:JAVADOC:5202 + Set the type of value to be formatted or parsed. Valid values are both, date, time localDate, localDateTime, localTime, offsetTime, offsetDateTime, or zonedDateTime. The values starting with "local", "offset" and "zoned" correspond to Java SE 8 Date Time API classes in package java.time with the name derived by upper casing the first letter. For example, java.time.LocalDate for the value "localDate". An invalid value will cause a ConverterException when getAsObject() or getAsString() is called. + jakarta.faces.convert + DateTimeConverter + + + java.lang.String + + + + + + JSF:JAVADOC:5203 + + jakarta.faces.convert + DoubleConverter + + + + + JSF:JAVADOC:5204 + Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle. + jakarta.faces.convert + DoubleConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:5205 + + jakarta.faces.convert + DoubleConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5206 + Reset the PartialStateHolder to a non-delta tracking state. + jakarta.faces.convert + EnumConverter + + + + + JSF:JAVADOC:5207 + For StateHolder + jakarta.faces.convert + EnumConverter + + + + + JSF:JAVADOC:5208 + Instantiates an enum converter with a class where enum constants are taken from. + jakarta.faces.convert + EnumConverter + + + java.lang.Class + + + + + + JSF:JAVADOC:5209 + Convert the value argument to one of the enum constants of the class provided in our constructor. If no target class argument has been provided to the constructor of this instance, throw a ConverterException containing the #ENUM_NO_CLASS_ID message with proper parameters. If the value argument is null or it has a length of zero, return null. Otherwise, perform the equivalent of Enum.valueOf using target class and value and return the Object. If the conversion fails, throw a ConverterException containing the #ENUM_ID message with proper parameters. + jakarta.faces.convert + EnumConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:5210 + Convert the enum constant given by the value argument into a String. If no target class argument has been provided to the constructor of this instance, throw a ConverterException containing the #ENUM_NO_CLASS_ID message with proper parameters. If the value argument is null, return the empty String. If the value is an instance of the provided target class, return its string value by casting it to a java.lang.Enum and returning the result of calling the name() method. Otherwise, throw a ConverterException containing the #ENUM_ID message with proper parameters. + jakarta.faces.convert + EnumConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5211 + Return true if delta state changes are being tracked, otherwise false + jakarta.faces.convert + EnumConverter + + + + + JSF:JAVADOC:5212 + + jakarta.faces.convert + EnumConverter + + + + + JSF:JAVADOC:5213 + The runtime must ensure that the #markInitialState method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state. The implementor of the interface must ensure that #initialStateMarked returns true from the time markInitialState() is called until #clearInitialState is called, after which time initialStateMarked() must return false. Also, during the time that the instance returns true from initialStateMarked(), the implementation must return only the state that has changed in its implementation of StateHolder#saveState. + jakarta.faces.convert + EnumConverter + + + + + JSF:JAVADOC:5214 + + jakarta.faces.convert + EnumConverter + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:5215 + + jakarta.faces.convert + EnumConverter + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5216 + + jakarta.faces.convert + EnumConverter + + + boolean + + + + + + JSF:JAVADOC:5217 + The value of this annotation attribute is taken to be the converter-for-class with which instances of this class of converter can be instantiated by calling jakarta.faces.application.Application#createConverter(java.lang.Class). + jakarta.faces.convert + FacesConverter + + + + + JSF:JAVADOC:5218 + The value of this annotation attribute is taken to be an indicator that flags whether or not the given converter is a CDI managed converter. + jakarta.faces.convert + FacesConverter + + + + + JSF:JAVADOC:5219 + The value of this annotation attribute is taken to be the converter-id with which instances of this class of converter can be instantiated by calling jakarta.faces.application.Application#createConverter(java.lang.String). + jakarta.faces.convert + FacesConverter + + + + + JSF:JAVADOC:5220 + The value of this annotation attribute is taken to be the converter-for-class with which instances of this class of converter can be instantiated by calling jakarta.faces.application.Application#createConverter(java.lang.Class). + jakarta.faces.convert + FacesConverter.Literal + + + + + JSF:JAVADOC:5221 + The value of this annotation attribute is taken to be an indicator that flags whether or not the given converter is a CDI managed converter. + jakarta.faces.convert + FacesConverter.Literal + + + + + JSF:JAVADOC:5222 + + jakarta.faces.convert + FacesConverter.Literal + + + java.lang.String + java.lang.Class + boolean + + + + + + JSF:JAVADOC:5223 + The value of this annotation attribute is taken to be the converter-id with which instances of this class of converter can be instantiated by calling jakarta.faces.application.Application#createConverter(java.lang.String). + jakarta.faces.convert + FacesConverter.Literal + + + + + JSF:JAVADOC:5224 + + jakarta.faces.convert + FloatConverter + + + + + JSF:JAVADOC:5225 + Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle. + jakarta.faces.convert + FloatConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:5226 + + jakarta.faces.convert + FloatConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5227 + Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle. + jakarta.faces.convert + IntegerConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:5228 + + jakarta.faces.convert + IntegerConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5229 + + jakarta.faces.convert + IntegerConverter + + + + + JSF:JAVADOC:5230 + Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle. + jakarta.faces.convert + LongConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:5231 + + jakarta.faces.convert + LongConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5232 + + jakarta.faces.convert + LongConverter + + + + + JSF:JAVADOC:5233 + Reset the PartialStateHolder to a non-delta tracking state. + jakarta.faces.convert + NumberConverter + + + + + JSF:JAVADOC:5234 + Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle. + jakarta.faces.convert + NumberConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:5235 + + jakarta.faces.convert + NumberConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5236 + Return the ISO 4217 currency code used by getAsString() with a type of currency. If not set, the value used will be based on the formatting Locale. + jakarta.faces.convert + NumberConverter + + + + + JSF:JAVADOC:5237 + Return the currency symbol used by getAsString() with a type of currency. If not set, the value used will be based on the formatting Locale. + jakarta.faces.convert + NumberConverter + + + + + JSF:JAVADOC:5238 + Return the Locale to be used when parsing numbers. If this value is null, the Locale stored in the jakarta.faces.component.UIViewRoot for the current request will be utilized. + jakarta.faces.convert + NumberConverter + + + + + JSF:JAVADOC:5239 + Return the maximum number of digits getAsString() should render in the fraction portion of the result. + jakarta.faces.convert + NumberConverter + + + + + JSF:JAVADOC:5240 + Return the maximum number of digits getAsString() should render in the integer portion of the result. + jakarta.faces.convert + NumberConverter + + + + + JSF:JAVADOC:5241 + Return the minimum number of digits getAsString() should render in the fraction portion of the result. + jakarta.faces.convert + NumberConverter + + + + + JSF:JAVADOC:5242 + Return the minimum number of digits getAsString() should render in the integer portion of the result. + jakarta.faces.convert + NumberConverter + + + + + JSF:JAVADOC:5243 + Return the format pattern to be used when formatting and parsing numbers. + jakarta.faces.convert + NumberConverter + + + + + JSF:JAVADOC:5244 + Return the number type to be used when formatting and parsing numbers. If not modified, the default type is number. + jakarta.faces.convert + NumberConverter + + + + + JSF:JAVADOC:5245 + Return true if delta state changes are being tracked, otherwise false + jakarta.faces.convert + NumberConverter + + + + + JSF:JAVADOC:5246 + Return true if getAsString should include grouping separators if necessary. If not modified, the default value is true. + jakarta.faces.convert + NumberConverter + + + + + JSF:JAVADOC:5247 + Return true if only the integer portion of the given value should be returned from getAsObject(). If not modified, the default value is false. + jakarta.faces.convert + NumberConverter + + + + + JSF:JAVADOC:5248 + + jakarta.faces.convert + NumberConverter + + + + + JSF:JAVADOC:5249 + The runtime must ensure that the #markInitialState method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state. The implementor of the interface must ensure that #initialStateMarked returns true from the time markInitialState() is called until #clearInitialState is called, after which time initialStateMarked() must return false. Also, during the time that the instance returns true from initialStateMarked(), the implementation must return only the state that has changed in its implementation of StateHolder#saveState. + jakarta.faces.convert + NumberConverter + + + + + JSF:JAVADOC:5250 + + jakarta.faces.convert + NumberConverter + + + + + JSF:JAVADOC:5251 + + jakarta.faces.convert + NumberConverter + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:5252 + + jakarta.faces.convert + NumberConverter + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5253 + Set the ISO 4217 currency code used by getAsString() with a type of currency. + jakarta.faces.convert + NumberConverter + + + java.lang.String + + + + + + JSF:JAVADOC:5254 + Set the currency symbol used by getAsString() with a type of currency. + jakarta.faces.convert + NumberConverter + + + java.lang.String + + + + + + JSF:JAVADOC:5255 + Set the flag indicating whether getAsString() should include grouping separators if necessary. + jakarta.faces.convert + NumberConverter + + + boolean + + + + + + JSF:JAVADOC:5256 + Set to true if only the integer portion of the given value should be returned from getAsObject(). + jakarta.faces.convert + NumberConverter + + + boolean + + + + + + JSF:JAVADOC:5257 + Set the Locale to be used when parsing numbers. If set to null, the Locale stored in the jakarta.faces.component.UIViewRoot for the current request will be utilized. + jakarta.faces.convert + NumberConverter + + + java.util.Locale + + + + + + JSF:JAVADOC:5258 + Set the maximum number of digits getAsString() should render in the fraction portion of the result. If not set, the number of digits depends on the value being converted. + jakarta.faces.convert + NumberConverter + + + int + + + + + + JSF:JAVADOC:5259 + Set the maximum number of digits getAsString() should render in the integer portion of the result. If not set, the number of digits depends on the value being converted. + jakarta.faces.convert + NumberConverter + + + int + + + + + + JSF:JAVADOC:5260 + Set the minimum number of digits getAsString() should render in the fraction portion of the result. If not set, the number of digits depends on the value being converted. + jakarta.faces.convert + NumberConverter + + + int + + + + + + JSF:JAVADOC:5261 + Set the minimum number of digits getAsString() should render in the integer portion of the result. If not set, the number of digits depends on the value being converted. + jakarta.faces.convert + NumberConverter + + + int + + + + + + JSF:JAVADOC:5262 + Set the format pattern to be used when formatting and parsing numbers. Valid values are those supported by java.text.DecimalFormat. An invalid value will cause a ConverterException when getAsObject() or getAsString() is called. + jakarta.faces.convert + NumberConverter + + + java.lang.String + + + + + + JSF:JAVADOC:5263 + + jakarta.faces.convert + NumberConverter + + + boolean + + + + + + JSF:JAVADOC:5264 + Set the number type to be used when formatting and parsing numbers. Valid values are currency, number, or percent. An invalid value will cause a ConverterException when getAsObject() or getAsString() is called. + jakarta.faces.convert + NumberConverter + + + java.lang.String + + + + + + JSF:JAVADOC:5265 + Convert the specified string value, which is associated with the specified UIComponent, into a model data object that is appropriate for being stored during the Process Validations phase of the request processing lifecycle. + jakarta.faces.convert + ShortConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:5266 + + jakarta.faces.convert + ShortConverter + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5267 + + jakarta.faces.convert + ShortConverter + + + + + JSF:JAVADOC:5268 + + jakarta.faces.el + CompositeComponentExpressionHolder + + + java.lang.String + + + + + + JSF:JAVADOC:5269 + Construct a new exception with the specified detail message and no root cause. + jakarta.faces.event + AbortProcessingException + + + java.lang.String + + + + + + JSF:JAVADOC:5270 + Construct a new exception with the specified root cause. + jakarta.faces.event + AbortProcessingException + + + java.lang.Throwable + + + + + + JSF:JAVADOC:5271 + Construct a new exception with the specified detail message and root cause. + jakarta.faces.event + AbortProcessingException + + + java.lang.String + java.lang.Throwable + + + + + + JSF:JAVADOC:5272 + Construct a new event object from the specified source component and action command. + jakarta.faces.event + ActionEvent + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5273 + Construct a new event object from the Faces context, specified source component and action command. + jakarta.faces.event + ActionEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5274 + Return true if this FacesListener is an instance of a listener class that this event supports. Typically, this will be accomplished by an "instanceof" check on the listener class. + jakarta.faces.event + ActionEvent + + + jakarta.faces.event.FacesListener + + + + + + JSF:JAVADOC:5275 + Broadcast this FacesEvent to the specified FacesListener, by whatever mechanism is appropriate. Typically, this will be accomplished by calling an event processing method, and passing this FacesEvent as a paramter. + jakarta.faces.event + ActionEvent + + + jakarta.faces.event.FacesListener + + + + + + JSF:JAVADOC:5276 + + jakarta.faces.event + ActionListenerWrapper + + + + + JSF:JAVADOC:5277 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.event + ActionListenerWrapper + + + + + JSF:JAVADOC:5278 + Invoked when the action described by the specified ActionEvent occurs. + jakarta.faces.event + ActionListenerWrapper + + + jakarta.faces.event.ActionEvent + + + + + + JSF:JAVADOC:5279 + Signal the Jakarta Faces implementation that no further processing on the current event should be performed + jakarta.faces.event + ActionListenerWrapper + + + jakarta.faces.event.ActionEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:5280 + Construct a new event object from the specified source component and Ajax behavior. + jakarta.faces.event + AjaxBehaviorEvent + + + jakarta.faces.component.UIComponent + jakarta.faces.component.behavior.Behavior + + + + + + JSF:JAVADOC:5281 + Construct a new event object from the Faces context, specified source component and Ajax behavior. + jakarta.faces.event + AjaxBehaviorEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + jakarta.faces.component.behavior.Behavior + + + + + + JSF:JAVADOC:5282 + Return true if this FacesListener is an instance of a the appropriate listener class that this event supports. + jakarta.faces.event + AjaxBehaviorEvent + + + jakarta.faces.event.FacesListener + + + + + + JSF:JAVADOC:5283 + Broadcast this event instance to the specified FacesListener, by whatever mechanism is appropriate. Typically, this will be accomplished by calling an event processing method, and passing this instance as a parameter. + jakarta.faces.event + AjaxBehaviorEvent + + + jakarta.faces.event.FacesListener + + + + + + JSF:JAVADOC:5284 + Process the Ajax behavior event. + jakarta.faces.event + AjaxBehaviorListener + + + jakarta.faces.event.AjaxBehaviorEvent + + + + + + JSF:JAVADOC:5285 + if lifecycle processing should cease for this request. + jakarta.faces.event + AjaxBehaviorListener + + + jakarta.faces.event.AjaxBehaviorEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:5286 + Construct a new event object from the specified source component and behavior. + jakarta.faces.event + BehaviorEvent + + + jakarta.faces.component.UIComponent + jakarta.faces.component.behavior.Behavior + + + + + + JSF:JAVADOC:5287 + Construct a new event object from the Faces context, specified source component and behavior. + jakarta.faces.event + BehaviorEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + jakarta.faces.component.behavior.Behavior + + + + + + JSF:JAVADOC:5288 + Return the source Behavior that sent this event. + jakarta.faces.event + BehaviorEvent + + + + + JSF:JAVADOC:5289 + Pass the argument component to the superclass constructor. + jakarta.faces.event + ComponentSystemEvent + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5290 + Pass the argument component to the superclass constructor. + jakarta.faces.event + ComponentSystemEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5291 + the source UIComponent that sent this event. + jakarta.faces.event + ComponentSystemEvent + + + + + JSF:JAVADOC:5292 + Return true if the argument FacesListener is an instance of the appropriate listener class that this event supports. The default implementation returns true if the listener is a ComponentSystemEventListener or if super.isAppropriateListener() returns true. + jakarta.faces.event + ComponentSystemEvent + + + jakarta.faces.event.FacesListener + + + + + + JSF:JAVADOC:5293 + Broadcast this event instance to the specified FacesListener by calling the superclass's processListener() implementation. + jakarta.faces.event + ComponentSystemEvent + + + jakarta.faces.event.FacesListener + + + + + + JSF:JAVADOC:5294 + When called, the listener can assume that any guarantees given in the javadoc for the specific SystemEvent subclass are true. + jakarta.faces.event + ComponentSystemEventListener + + + jakarta.faces.event.ComponentSystemEvent + + + + + + JSF:JAVADOC:5295 + if lifecycle processing should cease for this request. + jakarta.faces.event + ComponentSystemEventListener + + + jakarta.faces.event.ComponentSystemEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:5296 + Instantiate a new ExceptionQueuedEvent that indicates the argument ExceptionQueuedEventContext occurred. + jakarta.faces.event + ExceptionQueuedEvent + + + jakarta.faces.event.ExceptionQueuedEventContext + + + + + + JSF:JAVADOC:5297 + Instantiate a new ExceptionQueuedEvent that indicates the argument ExceptionQueuedEventContext occurred. + jakarta.faces.event + ExceptionQueuedEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.event.ExceptionQueuedEventContext + + + + + + JSF:JAVADOC:5298 + Return the ExceptionQueuedEventContext for this event instance. + jakarta.faces.event + ExceptionQueuedEvent + + + + + JSF:JAVADOC:5299 + Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable just occurred. + jakarta.faces.event + ExceptionQueuedEventContext + + + jakarta.faces.context.FacesContext + java.lang.Throwable + + + + + + JSF:JAVADOC:5300 + Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable just occurred, relevant to the argument component. + jakarta.faces.event + ExceptionQueuedEventContext + + + jakarta.faces.context.FacesContext + java.lang.Throwable + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5301 + Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable just occurred, relevant to the argument component, during the lifecycle phase phaseId. + jakarta.faces.event + ExceptionQueuedEventContext + + + jakarta.faces.context.FacesContext + java.lang.Throwable + jakarta.faces.component.UIComponent + jakarta.faces.event.PhaseId + + + + + + JSF:JAVADOC:5302 + A Map of attributes relevant to the context of this ExceptionQueuedEvent. + jakarta.faces.event + ExceptionQueuedEventContext + + + + + JSF:JAVADOC:5303 + Return the UIComponent which was being processed when the exception was thrown. If none or not available, this will be null. + jakarta.faces.event + ExceptionQueuedEventContext + + + + + JSF:JAVADOC:5304 + The FacesContext for this request. + jakarta.faces.event + ExceptionQueuedEventContext + + + + + JSF:JAVADOC:5305 + Return the exception property. + jakarta.faces.event + ExceptionQueuedEventContext + + + + + JSF:JAVADOC:5306 + Return a List that contains a single entry, the jakarta.faces.context.ExceptionHandler for the current request. + jakarta.faces.event + ExceptionQueuedEventContext + + + java.lang.Class + + + + + + JSF:JAVADOC:5307 + Return the PhaseId which was being processed when the exception was thrown. If none or not available, this will be null. + jakarta.faces.event + ExceptionQueuedEventContext + + + + + JSF:JAVADOC:5308 + + jakarta.faces.event + ExceptionQueuedEventContext + + + + + JSF:JAVADOC:5309 + + jakarta.faces.event + ExceptionQueuedEventContext + + + + + JSF:JAVADOC:5310 + Construct a new event object from the Faces context and specified source component. + jakarta.faces.event + FacesEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5311 + Get the Faces context. If the constructor was passed a FacesContext we return it, otherwise we call FacesContext.getCurrentInstance() and return it. + jakarta.faces.event + FacesEvent + + + + + JSF:JAVADOC:5312 + Return the identifier of the request processing phase during which this event should be delivered. Legal values are the singleton instances defined by the PhaseId class, including PhaseId.ANY_PHASE, which is the default value. + jakarta.faces.event + FacesEvent + + + + + JSF:JAVADOC:5313 + Return true if this FacesListener is an instance of a listener class that this event supports. Typically, this will be accomplished by an "instanceof" check on the listener class. + jakarta.faces.event + FacesEvent + + + jakarta.faces.event.FacesListener + + + + + + JSF:JAVADOC:5314 + Broadcast this FacesEvent to the specified FacesListener, by whatever mechanism is appropriate. Typically, this will be accomplished by calling an event processing method, and passing this FacesEvent as a paramter. + jakarta.faces.event + FacesEvent + + + jakarta.faces.event.FacesListener + + + + + + JSF:JAVADOC:5315 + Convenience method to queue this event for broadcast at the end of the current request processing lifecycle phase. + jakarta.faces.event + FacesEvent + + + + + JSF:JAVADOC:5316 + Set the PhaseId during which this event will be delivered. + jakarta.faces.event + FacesEvent + + + jakarta.faces.event.PhaseId + + + + + + JSF:JAVADOC:5317 + The kind of object that emits events of the type given by the value of the #systemEventClass attribute. It is valid to have Jakarta Expression Language Expressions in the value of this attribute, as long as the expression resolves to an instance of the expected type. + jakarta.faces.event + ListenerFor + + + + + JSF:JAVADOC:5318 + The kind of system event for which this class will be installed as a listener. The implementation only supports exact matches on the Class and must not honor subclass relationships. It is valid to have EL Expressions in the value of this attribute, as long as the expression resolves to an instance of the expected type. + jakarta.faces.event + ListenerFor + + + + + JSF:JAVADOC:5319 + + jakarta.faces.event + ListenersFor + + + + + JSF:JAVADOC:5320 + If true, the Object implementing this interface must not participate in state saving or restoring. + jakarta.faces.event + MethodExpressionActionListener + + + + + JSF:JAVADOC:5321 + + jakarta.faces.event + MethodExpressionActionListener + + + + + JSF:JAVADOC:5322 + Construct a ValueChangeListener that contains a MethodExpression. To accomodate method expression targets that take no arguments instead of taking an ActionEvent argument, the implementation of this class must take the argument methodExpressionOneArg, extract its expression string, and create another MethodExpression whose expected param types match those of a zero argument method. The usage requirements for both of these MethodExpression instances are described in #processAction. + jakarta.faces.event + MethodExpressionActionListener + + + jakarta.el.MethodExpression + + + + + + JSF:JAVADOC:5323 + + jakarta.faces.event + MethodExpressionActionListener + + + jakarta.el.MethodExpression + jakarta.el.MethodExpression + + + + + + JSF:JAVADOC:5324 + Call through to the MethodExpression passed in our constructor. First, try to invoke the MethodExpression passed to the constructor of this instance, passing the argument ActionEvent as the argument. If a MethodNotFoundException is thrown, call to the zero argument MethodExpression derived from the MethodExpression passed to the constructor of this instance. If that fails for any reason, throw an AbortProcessingException, including the cause of the failure. + jakarta.faces.event + MethodExpressionActionListener + + + jakarta.faces.event.ActionEvent + + + + + + JSF:JAVADOC:5325 + {@inheritDoc} + jakarta.faces.event + MethodExpressionActionListener + + + jakarta.faces.event.ActionEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:5326 + Both MethodExpression instances described in the constructor must be restored. + jakarta.faces.event + MethodExpressionActionListener + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:5327 + Both MethodExpression instances described in the constructor must be saved. + jakarta.faces.event + MethodExpressionActionListener + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5328 + Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring. + jakarta.faces.event + MethodExpressionActionListener + + + boolean + + + + + + JSF:JAVADOC:5329 + If true, the Object implementing this interface must not participate in state saving or restoring. + jakarta.faces.event + MethodExpressionValueChangeListener + + + + + JSF:JAVADOC:5330 + + jakarta.faces.event + MethodExpressionValueChangeListener + + + + + JSF:JAVADOC:5331 + Construct a ValueChangeListener that contains a MethodExpression.To accommodate method expression targets that take no arguments instead of taking a ValueChangeEvent argument, the implementation of this class must take the argument methodExpressionOneArg, extract its expression string, and create another MethodExpression whose expected param types match those of a zero argument method. The usage requirements for both of these MethodExpression instances are described in #processValueChange. + jakarta.faces.event + MethodExpressionValueChangeListener + + + jakarta.el.MethodExpression + + + + + + JSF:JAVADOC:5332 + Construct a ValueChangeListener that contains a MethodExpression. + jakarta.faces.event + MethodExpressionValueChangeListener + + + jakarta.el.MethodExpression + jakarta.el.MethodExpression + + + + + + JSF:JAVADOC:5333 + Call through to the MethodExpression passed in our constructor. First, try to invoke the MethodExpression passed to the constructor of this instance, passing the argument ValueChangeEvent as the argument. If a MethodNotFoundException is thrown, call to the zero argument MethodExpression derived from the MethodExpression passed to the constructor of this instance. If that fails for any reason, throw an AbortProcessingException, including the cause of the failure. + jakarta.faces.event + MethodExpressionValueChangeListener + + + jakarta.faces.event.ValueChangeEvent + + + + + + JSF:JAVADOC:5334 + {@inheritDoc} + jakarta.faces.event + MethodExpressionValueChangeListener + + + jakarta.faces.event.ValueChangeEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:5335 + Both MethodExpression instances described in the constructor must be restored. + jakarta.faces.event + MethodExpressionValueChangeListener + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:5336 + Both MethodExpression instances described in the constructor must be saved. + jakarta.faces.event + MethodExpressionValueChangeListener + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5337 + Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring. + jakarta.faces.event + MethodExpressionValueChangeListener + + + boolean + + + + + + JSF:JAVADOC:5338 + The value of this annotation attribute is taken to be the short name for the jakarta.faces.event.ComponentSystemEvent. If the value of this attribute is ommitted, the following algorithm must be used by the code that processes this annotation to determine its value. Get the unqualified class name (e.g., UserLoginEvent) Strip off the trailing "Event", if present (e.g., UserLogin) Convert the first character to lower-case (e.g., userLogin) Prepend the package name to the lower-cased name. + jakarta.faces.event + NamedEvent + + + + + JSF:JAVADOC:5339 + Return the FacesContext for the request being processed. + jakarta.faces.event + PhaseEvent + + + + + JSF:JAVADOC:5340 + Return the PhaseId representing the current request processing lifecycle phase. + jakarta.faces.event + PhaseEvent + + + + + JSF:JAVADOC:5341 + Construct a new event object from the specified parameters. The specified Lifecycle will be the source of this event. + jakarta.faces.event + PhaseEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.event.PhaseId + jakarta.faces.lifecycle.Lifecycle + + + + + + JSF:JAVADOC:5342 + Return the name of this phase. + jakarta.faces.event + PhaseId + + + + + JSF:JAVADOC:5343 + Return a PhaseId representation of the arcument phase. + jakarta.faces.event + PhaseId + + + java.lang.String + + + + + + JSF:JAVADOC:5344 + Handle a notification that the processing for a particular phase has just been completed. + jakarta.faces.event + PhaseListener + + + jakarta.faces.event.PhaseEvent + + + + + + JSF:JAVADOC:5345 + Handle a notification that the processing for a particular phase of the request processing lifecycle is about to begin. + jakarta.faces.event + PhaseListener + + + jakarta.faces.event.PhaseEvent + + + + + + JSF:JAVADOC:5346 + Return the identifier of the request processing phase during which this listener is interested in processing PhaseEvent events. Legal values are the singleton instances defined by the PhaseId class, including PhaseId.ANY_PHASE to indicate an interest in being notified for all standard phases. + jakarta.faces.event + PhaseListener + + + + + JSF:JAVADOC:5347 + Returns true if and only if the argument listener is an instance of SystemEventListener. + jakarta.faces.event + PostAddToViewEvent + + + jakarta.faces.event.FacesListener + + + + + + JSF:JAVADOC:5348 + Instantiate a new PostAddToViewEvent that indicates the argument component was just added to the view. + jakarta.faces.event + PostAddToViewEvent + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5349 + Instantiate a new PostAddToViewEvent that indicates the argument component was just added to the view. + jakarta.faces.event + PostAddToViewEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5350 + The source Application that sent this event. + jakarta.faces.event + PostConstructApplicationEvent + + + + + JSF:JAVADOC:5351 + Constructs a new PostConstructApplicationEvent for this application. + jakarta.faces.event + PostConstructApplicationEvent + + + jakarta.faces.application.Application + + + + + + JSF:JAVADOC:5352 + Constructs a new PostConstructApplicationEvent for this application. + jakarta.faces.event + PostConstructApplicationEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.application.Application + + + + + + JSF:JAVADOC:5353 + Return the ScopeContext for this event. + jakarta.faces.event + PostConstructCustomScopeEvent + + + + + JSF:JAVADOC:5354 + An instance of this event indicates that the custom scope enclosed within the argument scopeContext was just created. + jakarta.faces.event + PostConstructCustomScopeEvent + + + jakarta.faces.event.ScopeContext + + + + + + JSF:JAVADOC:5355 + An instance of this event indicates that the custom scope enclosed within the argument scopeContext was just created. + jakarta.faces.event + PostConstructCustomScopeEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.event.ScopeContext + + + + + + JSF:JAVADOC:5356 + Instantiate a new PostConstructViewMapEvent that indicates the argument root was just associated with its view map. + jakarta.faces.event + PostConstructViewMapEvent + + + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:5357 + Instantiate a new PostConstructViewMapEvent that indicates the argument root was just associated with its view map. + jakarta.faces.event + PostConstructViewMapEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:5358 + + jakarta.faces.event + PostKeepFlashValueEvent + + + + + JSF:JAVADOC:5359 + Instantiate a new PostKeepFlashValueEvent that indicates the argument key was just kept in the flash. If the argument is null, the literal Flash#NULL_VALUE must be passed to the superclass constructor. + jakarta.faces.event + PostKeepFlashValueEvent + + + java.lang.String + + + + + + JSF:JAVADOC:5360 + Instantiate a new PostKeepFlashValueEvent that indicates the argument key was just kept in the flash. If the argument is null, the literal Flash#NULL_VALUE must be passed to the superclass constructor. + jakarta.faces.event + PostKeepFlashValueEvent + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5361 + + jakarta.faces.event + PostPutFlashValueEvent + + + + + JSF:JAVADOC:5362 + Instantiate a new PostPutFlashValueEvent that indicates the argument key was just put to the flash. If the argument is null, the literal Flash#NULL_VALUE must be passed to the superclass constructor. + jakarta.faces.event + PostPutFlashValueEvent + + + java.lang.String + + + + + + JSF:JAVADOC:5363 + Instantiate a new PostPutFlashValueEvent that indicates the argument key was just put to the flash. If the argument is null, the literal Flash#NULL_VALUE must be passed to the superclass constructor. + jakarta.faces.event + PostPutFlashValueEvent + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5364 + Instantiate a new PostRenderViewEvent that indicates the argument root has just been rendered. + jakarta.faces.event + PostRenderViewEvent + + + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:5365 + Instantiate a new PostRenderViewEvent that indicates the argument root has just been rendered. + jakarta.faces.event + PostRenderViewEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:5366 + Instantiate a new PostRestoreStateEvent that indicates the argument component just had its state restored. + jakarta.faces.event + PostRestoreStateEvent + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5367 + Instantiate a new PostRestoreStateEvent that indicates the argument component just had its state restored. + jakarta.faces.event + PostRestoreStateEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5368 + + jakarta.faces.event + PostRestoreStateEvent + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5369 + Constructor + jakarta.faces.event + PostValidateEvent + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5370 + Constructor + jakarta.faces.event + PostValidateEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5371 + Instantiate a new PreClearFlashEvent that indicates the argument key was just put to the flash. + jakarta.faces.event + PreClearFlashEvent + + + java.util.Map + + + + + + JSF:JAVADOC:5372 + Instantiate a new PreClearFlashEvent that indicates the argument key was just put to the flash. + jakarta.faces.event + PreClearFlashEvent + + + jakarta.faces.context.FacesContext + java.util.Map + + + + + + JSF:JAVADOC:5373 + The source Application that sent this event. + jakarta.faces.event + PreDestroyApplicationEvent + + + + + JSF:JAVADOC:5374 + Constructs a new PreDestroyApplicationEvent for this application. + jakarta.faces.event + PreDestroyApplicationEvent + + + jakarta.faces.application.Application + + + + + + JSF:JAVADOC:5375 + Constructs a new PreDestroyApplicationEvent for this application. + jakarta.faces.event + PreDestroyApplicationEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.application.Application + + + + + + JSF:JAVADOC:5376 + Return the ScopeContext for this event. + jakarta.faces.event + PreDestroyCustomScopeEvent + + + + + JSF:JAVADOC:5377 + An instance of this event indicates that the custom scope enclosed within the argument scopeContext is about to end. + jakarta.faces.event + PreDestroyCustomScopeEvent + + + jakarta.faces.event.ScopeContext + + + + + + JSF:JAVADOC:5378 + An instance of this event indicates that the custom scope enclosed within the argument scopeContext is about to end. + jakarta.faces.event + PreDestroyCustomScopeEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.event.ScopeContext + + + + + + JSF:JAVADOC:5379 + Instantiate a new ViewMapDestroydEvent that indicates the argument root just had its associated view map destroyed. + jakarta.faces.event + PreDestroyViewMapEvent + + + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:5380 + Instantiate a new ViewMapDestroydEvent that indicates the argument root just had its associated view map destroyed. + jakarta.faces.event + PreDestroyViewMapEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:5381 + + jakarta.faces.event + PreRemoveFlashValueEvent + + + + + JSF:JAVADOC:5382 + Instantiate a new PreRemoveFlashValueEvent that indicates the argument key will be removed from the flash. If the argument is null, the literal Flash#NULL_VALUE must be passed to the superclass constructor. + jakarta.faces.event + PreRemoveFlashValueEvent + + + java.lang.String + + + + + + JSF:JAVADOC:5383 + Instantiate a new PreRemoveFlashValueEvent that indicates the argument key will be removed from the flash. If the argument is null, the literal Flash#NULL_VALUE must be passed to the superclass constructor. + jakarta.faces.event + PreRemoveFlashValueEvent + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5384 + Returns true if and only if the argument listener is an instance of SystemEventListener. + jakarta.faces.event + PreRemoveFromViewEvent + + + jakarta.faces.event.FacesListener + + + + + + JSF:JAVADOC:5385 + Instantiate a new BeforeRemoveFromView that indicates the argument component is about to be removed from the view. + jakarta.faces.event + PreRemoveFromViewEvent + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5386 + Instantiate a new BeforeRemoveFromView that indicates the argument component is about to be removed from the view. + jakarta.faces.event + PreRemoveFromViewEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5387 + Instantiate a new PreRenderComponentEvent that indicates the argument component is about to be rendered. + jakarta.faces.event + PreRenderComponentEvent + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5388 + Instantiate a new PreRenderComponentEvent that indicates the argument component is about to be rendered. + jakarta.faces.event + PreRenderComponentEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5389 + Instantiate a new PreRenderViewEvent that indicates the argument root is about to be rendered. + jakarta.faces.event + PreRenderViewEvent + + + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:5390 + Instantiate a new PreRenderViewEvent that indicates the argument root is about to be rendered. + jakarta.faces.event + PreRenderViewEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:5391 + Constructor + jakarta.faces.event + PreValidateEvent + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5392 + Constructor + jakarta.faces.event + PreValidateEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5393 + Return the scope itself, exposed as a Map. + jakarta.faces.event + ScopeContext + + + + + JSF:JAVADOC:5394 + Return the name of this custom scope. + jakarta.faces.event + ScopeContext + + + + + JSF:JAVADOC:5395 + Construct this structure with the supplied arguments. + jakarta.faces.event + ScopeContext + + + java.lang.String + java.util.Map + + + + + + JSF:JAVADOC:5396 + Get the Faces context. If the constructor was passed a FacesContext we return it, otherwise we call FacesContext.getCurrentInstance() and return it. + jakarta.faces.event + SystemEvent + + + + + JSF:JAVADOC:5397 + Return true if this FacesListener is an instance of a the appropriate listener class that this event supports. The default implementation returns true if the listener is a ComponentSystemEventListener. + jakarta.faces.event + SystemEvent + + + jakarta.faces.event.FacesListener + + + + + + JSF:JAVADOC:5398 + Broadcast this event instance to the specified FacesListener, by whatever mechanism is appropriate. Typically, this will be accomplished by calling an event processing method, and passing this instance as a parameter. + jakarta.faces.event + SystemEvent + + + jakarta.faces.event.FacesListener + + + + + + JSF:JAVADOC:5399 + Pass the argument source to the superclass constructor. + jakarta.faces.event + SystemEvent + + + java.lang.Object + + + + + + JSF:JAVADOC:5400 + Pass the argument source to the superclass constructor. + jakarta.faces.event + SystemEvent + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:5401 + This method must return true if and only if this listener instance is interested in receiving events from the instance referenced by the source parameter. + jakarta.faces.event + SystemEventListener + + + java.lang.Object + + + + + + JSF:JAVADOC:5402 + When called, the listener can assume that any guarantees given in the javadoc for the specific SystemEvent subclass are true. + jakarta.faces.event + SystemEventListener + + + jakarta.faces.event.SystemEvent + + + + + + JSF:JAVADOC:5403 + if lifecycle processing should cease for this request. + jakarta.faces.event + SystemEventListener + + + jakarta.faces.event.SystemEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:5404 + Return a List of SystemEventListener instances that have been installed into the class implementing this interface. + jakarta.faces.event + SystemEventListenerHolder + + + java.lang.Class + + + + + + JSF:JAVADOC:5405 + Return the current local value of the source UIComponent. + jakarta.faces.event + ValueChangeEvent + + + + + JSF:JAVADOC:5406 + Return the previous local value of the source UIComponent. + jakarta.faces.event + ValueChangeEvent + + + + + JSF:JAVADOC:5407 + Return true if this FacesListener is an instance of a listener class that this event supports. Typically, this will be accomplished by an "instanceof" check on the listener class. + jakarta.faces.event + ValueChangeEvent + + + jakarta.faces.event.FacesListener + + + + + + JSF:JAVADOC:5408 + Broadcast this FacesEvent to the specified FacesListener, by whatever mechanism is appropriate. Typically, this will be accomplished by calling an event processing method, and passing this FacesEvent as a paramter. + jakarta.faces.event + ValueChangeEvent + + + jakarta.faces.event.FacesListener + + + + + + JSF:JAVADOC:5409 + Construct a new event object from the specified source component, old value, and new value. The default PhaseId for this event is PhaseId#ANY_PHASE. + jakarta.faces.event + ValueChangeEvent + + + jakarta.faces.component.UIComponent + java.lang.Object + java.lang.Object + + + + + + JSF:JAVADOC:5410 + Construct a new event object from the Faces context, specified source component, old value and new value. The default PhaseId for this event is PhaseId#ANY_PHASE. + jakarta.faces.event + ValueChangeEvent + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + java.lang.Object + + + + + + JSF:JAVADOC:5411 + Invoked when the value change described by the specified ValueChangeEvent occurs. + jakarta.faces.event + ValueChangeListener + + + jakarta.faces.event.ValueChangeEvent + + + + + + JSF:JAVADOC:5412 + Signal the Jakarta Faces implementation that no further processing on the current event should be performed + jakarta.faces.event + ValueChangeListener + + + jakarta.faces.event.ValueChangeEvent + + jakarta.faces.event.AbortProcessingException + + + + + JSF:JAVADOC:5413 + + jakarta.faces.event + WebsocketEvent + + + java.lang.Object + + + + + + JSF:JAVADOC:5414 + Returns the . + jakarta.faces.event + WebsocketEvent + + + + + JSF:JAVADOC:5415 + Returns the close code. If this returns null, then it was Opened. If this returns non-null, then it was Closed. + jakarta.faces.event + WebsocketEvent + + + + + JSF:JAVADOC:5416 + Returns the , if any. + jakarta.faces.event + WebsocketEvent + + + + + JSF:JAVADOC:5417 + + jakarta.faces.event + WebsocketEvent + + + + + JSF:JAVADOC:5418 + + jakarta.faces.event + WebsocketEvent + + + + + JSF:JAVADOC:5419 + + jakarta.faces.event + WebsocketEvent + + + java.lang.String + java.io.Serializable + jakarta.websocket.CloseReason.CloseReason.CloseCode + + + + + + JSF:JAVADOC:5420 + + jakarta.faces.event + WebsocketEvent.Closed.Literal + + + + + JSF:JAVADOC:5421 + + jakarta.faces.event + WebsocketEvent.Opened.Literal + + + + + JSF:JAVADOC:5422 + + jakarta.faces.flow + Flow + + + + + JSF:JAVADOC:5423 + Get the ClientWindow's id and append "_" and the return from #getId. Return the result. + jakarta.faces.flow + Flow + + + jakarta.faces.lifecycle.ClientWindow + + + + + + JSF:JAVADOC:5424 + Return the immutable application unique identifier for the document in which the argument flow is defined. + jakarta.faces.flow + Flow + + + + + JSF:JAVADOC:5425 + Return the MethodExpression that must be called by the runtime as the last thing that happens before exiting this flow. Any FlowScoped beans declared for this flow must remain in scope until after control returns from the method referenced by this MethodExpression. + jakarta.faces.flow + Flow + + + + + JSF:JAVADOC:5426 + Return the FlowCallNode that represents calling the targetFlow from this flow, or null if targetFlow cannot be reached from this flow. + jakarta.faces.flow + Flow + + + jakarta.faces.flow.Flow + + + + + + JSF:JAVADOC:5427 + Return an immutable data structure containing all the flow call nodes declared for this flow. + jakarta.faces.flow + Flow + + + + + JSF:JAVADOC:5428 + Return the immutable id for this Flow. This must be unique within the defining document (such as an Application Configuration Resources file), but need not be unique within the entire application. + jakarta.faces.flow + Flow + + + + + JSF:JAVADOC:5429 + Return an immutable data structure containing the inbound parameters that have been declared for this flow. See FlowHandler#transition for the specification of how these parameters are used. Inbound parameters are associated with a specific flow instance, while outbound parameters are associated with a FlowCallNode that causes the transition to a new flow. + jakarta.faces.flow + Flow + + + + + JSF:JAVADOC:5430 + Return the MethodExpression that must be called by the runtime immediately after activating any FlowScoped beans declared for this flow. + jakarta.faces.flow + Flow + + + + + JSF:JAVADOC:5431 + Return an immutable data structure containing all the method call nodes declared for this flow. + jakarta.faces.flow + Flow + + + + + JSF:JAVADOC:5432 + Return an unmodifiable view of the navigation cases within this flow. + jakarta.faces.flow + Flow + + + + + JSF:JAVADOC:5433 + Return the generic FlowNode by id, or null if not found. + jakarta.faces.flow + Flow + + + java.lang.String + + + + + + JSF:JAVADOC:5434 + Return an immutable data structure containing all of the return nodes declared for this flow. + jakarta.faces.flow + Flow + + + + + JSF:JAVADOC:5435 + Return the immutable id for the default node that should be activated when this flow is entered. + jakarta.faces.flow + Flow + + + + + JSF:JAVADOC:5436 + Return an immutable data structure containing all of the switch nodes declared for this flow. + jakarta.faces.flow + Flow + + + + + JSF:JAVADOC:5437 + Return an immutable data structure containing all of the view nodes declared for this flow. + jakarta.faces.flow + Flow + + + + + JSF:JAVADOC:5438 + + jakarta.faces.flow + FlowCallNode + + + + + JSF:JAVADOC:5439 + + jakarta.faces.flow + FlowCallNode + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5440 + + jakarta.faces.flow + FlowCallNode + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5441 + + jakarta.faces.flow + FlowCallNode + + + + + JSF:JAVADOC:5442 + Add the argument Flow to the collection of Flows known to the current application. The implementation must be thread safe. + jakarta.faces.flow + FlowHandler + + + jakarta.faces.context.FacesContext + jakarta.faces.flow.Flow + + + + + + JSF:JAVADOC:5443 + Allow for flow transitions in the case of components rendered by the renderers from component-family jakarta.faces.OutcomeTarget. These transitions must happen at the front of the request processing lifecycle due to the HTTP GET based nature of such components. Therefore, this method is called from the restore view phase of the lifecycle. Let flowId be the value in the request parameter map for the parameter whose name is given by the value of #FLOW_ID_REQUEST_PARAM_NAME. Let toFlowDocumentId be the value in the request parameter map for the paramater whose name is given by the value of #TO_FLOW_DOCUMENT_ID_REQUEST_PARAM_NAME. If toFlowDocumentId is null, take no action and return. Otherwise, let sourceFlow be the return from #getCurrentFlow(jakarta.faces.context.FacesContext). A null value indicates there is no current flow, which will be the case if this navigation is trying to enter a flow. If flowId is not null and toFlowDocumentId is not equal to the value of #NULL_FLOW, let targetFlow be the result of calling #getFlow(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String), passing toFlowDocumentId and flowId as the last two arguments, respectively. If the result is non-null, let flowCallNode be the return from calling Flow#getFlowCall on the sourceFlow, passing targetFlow as the argument. Otherwise, targetFlow and flowCallNode must remain null, indicating that this is a flow return. Call FacesContext#getViewRoot() and let toViewId be the the return from calling jakarta.faces.component.UIViewRoot#getViewId on it. Call, #transition, passing the arguments gathered in the preceding algorithm. + jakarta.faces.flow + FlowHandler + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5444 + + jakarta.faces.flow + FlowHandler + + + + + JSF:JAVADOC:5445 + Return the currently active Flow for the argument FacesContext, or null if no flow is active. A Flow must always be associated with exactly one jakarta.faces.lifecycle.ClientWindow, but a ClientWindow may have multiple Flows. If #pushReturnMode had been called with true as the argument before invoking this method, return the preceding flow on the stack instead of the actual current flow, or null if there is no preceding flow. Otherwise, return the current flow. + jakarta.faces.flow + FlowHandler + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5446 + Convenience overload that calls FacesContext#getCurrentInstance() and then calls through to #getCurrentFlow(jakarta.faces.context.FacesContext). + jakarta.faces.flow + FlowHandler + + + + + JSF:JAVADOC:5447 + Return the Map that backs the #{flowScope} Jakarta Expression Language implicit object or null if no flow is currently active. + jakarta.faces.flow + FlowHandler + + + + + JSF:JAVADOC:5448 + Return the Flow whose id is equivalent to the argument id, within the scope of the argument definingDocument. + jakarta.faces.flow + FlowHandler + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:5449 + Return the last displayed viewId for the current flow, as returned by #getCurrentFlow(jakarta.faces.context.FacesContext), or null if there is no current flow. + jakarta.faces.flow + FlowHandler + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5450 + Return true if and only if the flow referenced by the argument definingDocument and id is currently active. + jakarta.faces.flow + FlowHandler + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:5451 + Enable the correct handling of navigation when processing a return node. The default jakarta.faces.application.NavigationHandler specification requires calling this method from a finally block, immediately attempting to process the navigation rules in the context of a flow return. + jakarta.faces.flow + FlowHandler + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5452 + Enable the correct handling of navigation when processing a return node. The default jakarta.faces.application.NavigationHandler specification requires calling this method before processing the navigation rules for the flow return, and calling #popReturnMode, from a finally block, immediately afterward. + jakarta.faces.flow + FlowHandler + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5453 + Perform a transition in the flow graph for the current user's jakarta.faces.lifecycle.ClientWindow. Obtain references to the Flow instances corresponding to the origin and destination arguments. If the origin Flow is equal to the destination Flow, take no action and return null. Otherwise, if the outboundCallNode argument is non-null save aside the outbound parameters. For discussion evaluatedParams is a data structure that stores the evaluated values of any outbound parameters. It is necessary to evaluate these values before popping any flow scopes because the values may refer to scoped instances that need to be passed to the target flow, but will not be available once the new scope is activated. Save aside the outbound parameters using the following algorithm. If the outboundParameters property of outboundCallNode is non-null and not empty, and the inboundParameters property of the target flow is non-null and not empty, for each entry in the outbound parameters whose name matches an entry in the inbound parameters, evaluate the value of the parameter, and put the evaluated value into evaluatedParams under the corresponding name. Otherwise, consider evaluatedParams to be empty. If the destination Flow is a sub-flow of the origin Flow push the destination Flow onto the flow data structure and return the destination Flow. Otherwise, pop the current Flow from the flow data structure. If the destination Flow is non-null, make the destination Flow the current flow, pushing it onto the data structure. If evaluatedParams is not empty, for each entry, find the corresponding parameter in the target flow's inbound parameters and call its setValue method, passing the value from evaluatedParams. + jakarta.faces.flow + FlowHandler + + + jakarta.faces.context.FacesContext + jakarta.faces.flow.Flow + jakarta.faces.flow.Flow + jakarta.faces.flow.FlowCallNode + java.lang.String + + + + + + JSF:JAVADOC:5454 + Create the singleton instance of FlowHandler. + jakarta.faces.flow + FlowHandlerFactory + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5455 + + jakarta.faces.flow + FlowHandlerFactory + + + + + JSF:JAVADOC:5456 + Create the singleton instance of FlowHandler. + jakarta.faces.flow + FlowHandlerFactoryWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5457 + + jakarta.faces.flow + FlowHandlerFactoryWrapper + + + + + JSF:JAVADOC:5458 + If this flow handler factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.flow + FlowHandlerFactoryWrapper + + + jakarta.faces.flow.FlowHandlerFactory + + + + + + JSF:JAVADOC:5459 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.flow + FlowHandlerFactoryWrapper + + + + + JSF:JAVADOC:5460 + + jakarta.faces.flow + FlowNode + + + + + JSF:JAVADOC:5461 + + jakarta.faces.flow + FlowNode + + + + + JSF:JAVADOC:5462 + If not empty, declare the defining document id within which the Flow referenced by #value is unique. If empty the, the runtime assumes that all flow ids are unique within the scope of the application. + jakarta.faces.flow + FlowScoped + + + + + JSF:JAVADOC:5463 + Must be equivalent to the Flow#getId of a defined flow for this application. + jakarta.faces.flow + FlowScoped + + + + + JSF:JAVADOC:5464 + Return the MethodExpression to be invoked to when control passes to this node. + jakarta.faces.flow + MethodCallNode + + + + + JSF:JAVADOC:5465 + Return the outcome to be used in the event of a null return from the method. + jakarta.faces.flow + MethodCallNode + + + + + JSF:JAVADOC:5466 + Return the parameters to be passed to the method. + jakarta.faces.flow + MethodCallNode + + + + + JSF:JAVADOC:5467 + + jakarta.faces.flow + MethodCallNode + + + + + JSF:JAVADOC:5468 + Return the name of the parameter + jakarta.faces.flow + Parameter + + + + + JSF:JAVADOC:5469 + Return a ValueExpression for the value of the parameter. Depending on the context, this expression may only ever be evaluated in a "get" operation. + jakarta.faces.flow + Parameter + + + + + JSF:JAVADOC:5470 + + jakarta.faces.flow + Parameter + + + + + JSF:JAVADOC:5471 + Return the fromOutcome to be used when control passes to this return node. + jakarta.faces.flow + ReturnNode + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5472 + + jakarta.faces.flow + ReturnNode + + + + + JSF:JAVADOC:5473 + Return true if this case should be taken, false otherwise. + jakarta.faces.flow + SwitchCase + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5474 + Return the outcome to be used if #getCondition return true. + jakarta.faces.flow + SwitchCase + + + + + JSF:JAVADOC:5475 + + jakarta.faces.flow + SwitchCase + + + + + JSF:JAVADOC:5476 + Return the cases in this switch. + jakarta.faces.flow + SwitchNode + + + + + JSF:JAVADOC:5477 + Return the default outcome in this switch. + jakarta.faces.flow + SwitchNode + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5478 + + jakarta.faces.flow + SwitchNode + + + + + JSF:JAVADOC:5479 + Return the immutable VDL document id for this view node. This is normally the path to the VDL page that defines this view node. This must be unique within the flow. + jakarta.faces.flow + ViewNode + + + + + JSF:JAVADOC:5480 + + jakarta.faces.flow + ViewNode + + + + + JSF:JAVADOC:5481 + A MethodExpression that will be invoked when the flow is exited. + jakarta.faces.flow.builder + FlowBuilder + + + jakarta.el.MethodExpression + + + + + + JSF:JAVADOC:5482 + A MethodExpression that will be invoked when the flow is exited. + jakarta.faces.flow.builder + FlowBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5483 + + jakarta.faces.flow.builder + FlowBuilder + + + + + JSF:JAVADOC:5484 + Define a flow call node. This node will cause the specified flow to be called, passing parameters if necessary. + jakarta.faces.flow.builder + FlowBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5485 + Called as the last step in flow definition, this method must perform any implementation specific initialization and return the built Flow. If called more than one time during a given flow building process, the second and subsequent invocations must take no action and return the built flow. + jakarta.faces.flow.builder + FlowBuilder + + + + + JSF:JAVADOC:5486 + Set the defining document id and flow id of this flow. + jakarta.faces.flow.builder + FlowBuilder + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:5487 + A parameter that will be populated with the value from a correspondingly named outbound parameter from another flow when this flow is entered from that flow. + jakarta.faces.flow.builder + FlowBuilder + + + java.lang.String + jakarta.el.ValueExpression + + + + + + JSF:JAVADOC:5488 + A parameter that will be populated with the value from a correspondingly named outbound parameter from another flow when this flow is entered from that flow. + jakarta.faces.flow.builder + FlowBuilder + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:5489 + A MethodExpression that will be invoked when the flow is entered. + jakarta.faces.flow.builder + FlowBuilder + + + jakarta.el.MethodExpression + + + + + + JSF:JAVADOC:5490 + A MethodExpression that will be invoked when the flow is entered. + jakarta.faces.flow.builder + FlowBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5491 + Define a method call node. This node will cause the specified method to be invoked, passing parameters if necessary. The return from the method is used as the outcome for where to go next in the flow. If the method is a void method, the default outcome is used. + jakarta.faces.flow.builder + FlowBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5492 + Define a particular combination of conditions that must match for this case to be executed, and the view id of the component tree that should be selected next. + jakarta.faces.flow.builder + FlowBuilder + + + + + JSF:JAVADOC:5493 + Define a return node. This node will cause the specified outcome to be returned to the calling flow. + jakarta.faces.flow.builder + FlowBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5494 + Define a particular list of cases that will be inspected in the order they are defined to determine where to go next in the flow graph. If none of the cases match, the outcome from the default case is chosen. + jakarta.faces.flow.builder + FlowBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5495 + Define a view node in a flow graph. + jakarta.faces.flow.builder + FlowBuilder + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:5496 + + jakarta.faces.flow.builder + FlowBuilderParameter.Literal + + + + + JSF:JAVADOC:5497 + + jakarta.faces.flow.builder + FlowCallBuilder + + + + + JSF:JAVADOC:5498 + Define the flow reference of the called flow. + jakarta.faces.flow.builder + FlowCallBuilder + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:5499 + Mark this node as the start node in the flow. Any other node that had been marked as the start node will no longer be the start node. + jakarta.faces.flow.builder + FlowCallBuilder + + + + + JSF:JAVADOC:5500 + Define an outbound parameter for the flow call. + jakarta.faces.flow.builder + FlowCallBuilder + + + java.lang.String + jakarta.el.ValueExpression + + + + + + JSF:JAVADOC:5501 + Define an outbound parameter for the flow call. + jakarta.faces.flow.builder + FlowCallBuilder + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:5502 + + jakarta.faces.flow.builder + FlowDefinition.Literal + + + + + JSF:JAVADOC:5503 + If the method is a void method, or the method returns null, this can be used to specify what value should be passed to runtime when the method returns. + jakarta.faces.flow.builder + MethodCallBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5504 + If the method is a void method, or the method returns null, this can be used to specify what value should be passed to runtime when the method returns. + jakarta.faces.flow.builder + MethodCallBuilder + + + jakarta.el.ValueExpression + + + + + + JSF:JAVADOC:5505 + Set the method expression of this method call node. The method signature of the argument methodExpression must match the number and type of the parameters passed in the #parameters method. + jakarta.faces.flow.builder + MethodCallBuilder + + + jakarta.el.MethodExpression + + + + + + JSF:JAVADOC:5506 + Set the method expression of this method call node. The method signature of the argument methodExpression must match the number and type of the parameters passed in the #parameters method. + jakarta.faces.flow.builder + MethodCallBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5507 + Set the method expression of this method call node. The method signature of the argument methodExpression must match the number and type of the parameters passed in the #parameters method. + jakarta.faces.flow.builder + MethodCallBuilder + + + java.lang.String + java.lang.Class[] + + + + + + JSF:JAVADOC:5508 + Mark this node as the start node in the flow. Any other node that had been marked as the start node will no longer be the start node. + jakarta.faces.flow.builder + MethodCallBuilder + + + + + JSF:JAVADOC:5509 + + jakarta.faces.flow.builder + MethodCallBuilder + + + + + JSF:JAVADOC:5510 + Set the parameters of the method call node. + jakarta.faces.flow.builder + MethodCallBuilder + + + java.util.List + + + + + + JSF:JAVADOC:5511 + Set the if of the current navigation case. + jakarta.faces.flow.builder + NavigationCaseBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5512 + Set the if of the current navigation case. + jakarta.faces.flow.builder + NavigationCaseBuilder + + + jakarta.el.ValueExpression + + + + + + JSF:JAVADOC:5513 + Set the from-action of the current navigation case. + jakarta.faces.flow.builder + NavigationCaseBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5514 + Set the from-outcome of the current navigation case. + jakarta.faces.flow.builder + NavigationCaseBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5515 + Set the from-view-id of the current navigation case. + jakarta.faces.flow.builder + NavigationCaseBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5516 + + jakarta.faces.flow.builder + NavigationCaseBuilder + + + + + JSF:JAVADOC:5517 + Create a redirect within this navigation case. + jakarta.faces.flow.builder + NavigationCaseBuilder + + + + + JSF:JAVADOC:5518 + Set the to-flow-document-id of the current navigation case. + jakarta.faces.flow.builder + NavigationCaseBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5519 + Set the to-view-id of the current navigation case. + jakarta.faces.flow.builder + NavigationCaseBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5520 + Indicates the current redirect should include view parameters. + jakarta.faces.flow.builder + NavigationCaseBuilder.RedirectBuilder + + + + + JSF:JAVADOC:5521 + + jakarta.faces.flow.builder + NavigationCaseBuilder.RedirectBuilder + + + + + JSF:JAVADOC:5522 + Add a parameter to the redirect. + jakarta.faces.flow.builder + NavigationCaseBuilder.RedirectBuilder + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:5523 + Mark this node as the start node in the flow. Any other node that had been marked as the start node will no longer be the start node. + jakarta.faces.flow.builder + NodeBuilder + + + + + JSF:JAVADOC:5524 + Set the outcome of the current return node. + jakarta.faces.flow.builder + ReturnBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5525 + Set the outcome of the current return node. + jakarta.faces.flow.builder + ReturnBuilder + + + jakarta.el.ValueExpression + + + + + + JSF:JAVADOC:5526 + Mark this node as the start node in the flow. Any other node that had been marked as the start node will no longer be the start node. + jakarta.faces.flow.builder + ReturnBuilder + + + + + JSF:JAVADOC:5527 + + jakarta.faces.flow.builder + ReturnBuilder + + + + + JSF:JAVADOC:5528 + Set the default outcome of the current switch. + jakarta.faces.flow.builder + SwitchBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5529 + Set the default outcome of the current switch. + jakarta.faces.flow.builder + SwitchBuilder + + + jakarta.el.ValueExpression + + + + + + JSF:JAVADOC:5530 + Mark this node as the start node in the flow. Any other node that had been marked as the start node will no longer be the start node. + jakarta.faces.flow.builder + SwitchBuilder + + + + + JSF:JAVADOC:5531 + + jakarta.faces.flow.builder + SwitchBuilder + + + + + JSF:JAVADOC:5532 + Create a switch case in the current switch. + jakarta.faces.flow.builder + SwitchBuilder + + + + + JSF:JAVADOC:5533 + Set the if in the previously created switch case. + jakarta.faces.flow.builder + SwitchCaseBuilder + + + jakarta.el.ValueExpression + + + + + + JSF:JAVADOC:5534 + Set the if in the previously created switch case. + jakarta.faces.flow.builder + SwitchCaseBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5535 + Set the outcome in the previously created switch case. + jakarta.faces.flow.builder + SwitchCaseBuilder + + + java.lang.String + + + + + + JSF:JAVADOC:5536 + Create a new case in the current switch. + jakarta.faces.flow.builder + SwitchCaseBuilder + + + + + JSF:JAVADOC:5537 + + jakarta.faces.flow.builder + SwitchCaseBuilder + + + + + JSF:JAVADOC:5538 + Mark this node as the start node in the flow. Any other node that had been marked as the start node will no longer be the start node. + jakarta.faces.flow.builder + ViewBuilder + + + + + JSF:JAVADOC:5539 + + jakarta.faces.flow.builder + ViewBuilder + + + + + JSF:JAVADOC:5540 + + jakarta.faces.lifecycle + ClientWindow + + + + + JSF:JAVADOC:5541 + The implementation is responsible for examining the incoming request and extracting the value that must be returned from the #getId method. If #CLIENT_WINDOW_MODE_PARAM_NAME is "none" this method must not be invoked. If #CLIENT_WINDOW_MODE_PARAM_NAME is "url" the implementation must first look for a request parameter under the name given by the value of jakarta.faces.render.ResponseStateManager#CLIENT_WINDOW_PARAM. If no value is found, look for a request parameter under the name given by the value of jakarta.faces.render.ResponseStateManager#CLIENT_WINDOW_URL_PARAM. If no value is found, fabricate an id that uniquely identifies this ClientWindow within the scope of the current session. This value must be made available to return from the #getId method. The value must be suitable for inclusion as a hidden field or query parameter. If a value is found, decrypt it using the key from the session and make it available for return from #getId. + jakarta.faces.lifecycle + ClientWindow + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5542 + Components that permit per-use disabling of the appending of the ClientWindow in generated URLs must call this method first before rendering those URLs. The caller must call #enableClientWindowRenderMode(jakarta.faces.context.FacesContext) from a finally block after rendering the URL. If #CLIENT_WINDOW_MODE_PARAM_NAME is "url" without the quotes, all generated URLs that cause a GET request must append the ClientWindow by default. This is specified as a static method because callsites need to access it without having access to an actual ClientWindow instance. + jakarta.faces.lifecycle + ClientWindow + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5543 + Components that permit per-use disabling of the appending of the ClientWindow in generated URLs must call this method first after rendering those URLs. If #CLIENT_WINDOW_MODE_PARAM_NAME is "url" without the quotes, all generated URLs that cause a GET request must append the ClientWindow by default. This is specified as a static method because callsites need to access it without having access to an actual ClientWindow instance. + jakarta.faces.lifecycle + ClientWindow + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5544 + Return a String value that uniquely identifies this ClientWindow within the scope of the current session. See #decode for the specification of how to derive this value. + jakarta.faces.lifecycle + ClientWindow + + + + + JSF:JAVADOC:5545 + This method will be called whenever a URL is generated by the runtime where client window related parameters need to be inserted into the URL. This guarantees custom ClientWindow implementations that they will have the opportunity to insert any additional client window specific information in any case where a URL is generated, such as the rendering of hyperlinks. The returned map must be immutable. The default implementation of this method returns the empty map. + jakarta.faces.lifecycle + ClientWindow + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5546 + Methods that append the ClientWindow to generated URLs must call this method to see if they are permitted to do so. If #CLIENT_WINDOW_MODE_PARAM_NAME is "url" without the quotes, all generated URLs that cause a GET request must append the ClientWindow by default. This is specified as a static method because callsites need to access it without having access to an actual ClientWindow instance. + jakarta.faces.lifecycle + ClientWindow + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5547 + + jakarta.faces.lifecycle + ClientWindowFactory + + + + + JSF:JAVADOC:5548 + If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.lifecycle + ClientWindowFactory + + + jakarta.faces.lifecycle.ClientWindowFactory + + + + + + JSF:JAVADOC:5549 + The implementation is responsible for creating the ClientWindow instance for this request. If ClientWindow#CLIENT_WINDOW_MODE_PARAM_NAME is "none" or unspecified, this method must return null. If ClientWindow#CLIENT_WINDOW_MODE_PARAM_NAME is "url" the implementation must return a ClientWindow instance that implements the url-mode semantics described in ClientWindow. + jakarta.faces.lifecycle + ClientWindowFactory + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5550 + If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped. + jakarta.faces.lifecycle + ClientWindowFactory + + + + + JSF:JAVADOC:5551 + + jakarta.faces.lifecycle + ClientWindowWrapper + + + + + JSF:JAVADOC:5552 + If this client window has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.lifecycle + ClientWindowWrapper + + + jakarta.faces.lifecycle.ClientWindow + + + + + + JSF:JAVADOC:5553 + The implementation is responsible for examining the incoming request and extracting the value that must be returned from the #getId method. If #CLIENT_WINDOW_MODE_PARAM_NAME is "none" this method must not be invoked. If #CLIENT_WINDOW_MODE_PARAM_NAME is "url" the implementation must first look for a request parameter under the name given by the value of jakarta.faces.render.ResponseStateManager#CLIENT_WINDOW_PARAM. If no value is found, look for a request parameter under the name given by the value of jakarta.faces.render.ResponseStateManager#CLIENT_WINDOW_URL_PARAM. If no value is found, fabricate an id that uniquely identifies this ClientWindow within the scope of the current session. This value must be made available to return from the #getId method. The value must be suitable for inclusion as a hidden field or query parameter. If a value is found, decrypt it using the key from the session and make it available for return from #getId. + jakarta.faces.lifecycle + ClientWindowWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5554 + Components that permit per-use disabling of the appending of the ClientWindow in generated URLs must call this method first before rendering those URLs. The caller must call #enableClientWindowRenderMode(jakarta.faces.context.FacesContext) from a finally block after rendering the URL. If #CLIENT_WINDOW_MODE_PARAM_NAME is "url" without the quotes, all generated URLs that cause a GET request must append the ClientWindow by default. This is specified as a static method because callsites need to access it without having access to an actual ClientWindow instance. + jakarta.faces.lifecycle + ClientWindowWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5555 + Components that permit per-use disabling of the appending of the ClientWindow in generated URLs must call this method first after rendering those URLs. If #CLIENT_WINDOW_MODE_PARAM_NAME is "url" without the quotes, all generated URLs that cause a GET request must append the ClientWindow by default. This is specified as a static method because callsites need to access it without having access to an actual ClientWindow instance. + jakarta.faces.lifecycle + ClientWindowWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5556 + Return a String value that uniquely identifies this ClientWindow within the scope of the current session. See #decode for the specification of how to derive this value. + jakarta.faces.lifecycle + ClientWindowWrapper + + + + + JSF:JAVADOC:5557 + This method will be called whenever a URL is generated by the runtime where client window related parameters need to be inserted into the URL. This guarantees custom ClientWindow implementations that they will have the opportunity to insert any additional client window specific information in any case where a URL is generated, such as the rendering of hyperlinks. The returned map must be immutable. The default implementation of this method returns the empty map. + jakarta.faces.lifecycle + ClientWindowWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5558 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.lifecycle + ClientWindowWrapper + + + + + JSF:JAVADOC:5559 + Methods that append the ClientWindow to generated URLs must call this method to see if they are permitted to do so. If #CLIENT_WINDOW_MODE_PARAM_NAME is "url" without the quotes, all generated URLs that cause a GET request must append the ClientWindow by default. This is specified as a static method because callsites need to access it without having access to an actual ClientWindow instance. + jakarta.faces.lifecycle + ClientWindowWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5560 + Register a new PhaseListener instance that is interested in being notified before and after the processing for standard phases of the request processing lifecycle. + jakarta.faces.lifecycle + Lifecycle + + + jakarta.faces.event.PhaseListener + + + + + + JSF:JAVADOC:5561 + Create or restore the ClientWindow to be used to display the jakarta.faces.component.UIViewRoot for this run through the lifecycle. See the class documentation for ClientWindow for an overview of the feature. If jakarta.faces.context.ExternalContext#getClientWindow() returns null, create a new instance of ClientWindow using the ClientWindowFactory. If the result is non-null, call ClientWindow#decode(jakarta.faces.context.FacesContext) on it. Store the new ClientWindow by calling jakarta.faces.context.ExternalContext#setClientWindow(jakarta.faces.lifecycle.ClientWindow). + jakarta.faces.lifecycle + Lifecycle + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5562 + Return the set of registered PhaseListeners for this Lifecycle instance. If there are no registered listeners, a zero-length array is returned. + jakarta.faces.lifecycle + Lifecycle + + + + + JSF:JAVADOC:5563 + Deregister an existing PhaseListener instance that is no longer interested in being notified before and after the processing for standard phases of the request processing lifecycle. If no such listener instance has been registered, no action is taken. + jakarta.faces.lifecycle + Lifecycle + + + jakarta.faces.event.PhaseListener + + + + + + JSF:JAVADOC:5564 + Execute the Render Response phase of the request processing lifecycle, unless the responseComplete() method has been called on the FacesContext instance associated with the current request. + jakarta.faces.lifecycle + Lifecycle + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5565 + if an exception is thrown during the execution of the request processing lifecycle + jakarta.faces.lifecycle + Lifecycle + + + jakarta.faces.context.FacesContext + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:5566 + If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped. + jakarta.faces.lifecycle + LifecycleFactory + + + + + JSF:JAVADOC:5567 + If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.lifecycle + LifecycleFactory + + + jakarta.faces.lifecycle.LifecycleFactory + + + + + + JSF:JAVADOC:5568 + Register a new PhaseListener instance that is interested in being notified before and after the processing for standard phases of the request processing lifecycle. + jakarta.faces.lifecycle + LifecycleWrapper + + + jakarta.faces.event.PhaseListener + + + + + + JSF:JAVADOC:5569 + Create or restore the ClientWindow to be used to display the jakarta.faces.component.UIViewRoot for this run through the lifecycle. See the class documentation for ClientWindow for an overview of the feature. If jakarta.faces.context.ExternalContext#getClientWindow() returns null, create a new instance of ClientWindow using the ClientWindowFactory. If the result is non-null, call ClientWindow#decode(jakarta.faces.context.FacesContext) on it. Store the new ClientWindow by calling jakarta.faces.context.ExternalContext#setClientWindow(jakarta.faces.lifecycle.ClientWindow). + jakarta.faces.lifecycle + LifecycleWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5570 + Execute all of the phases of the request processing lifecycle, up to but not including the Render Response phase, as described in section 2 "Request Processing Lifecycle" of the Jakarta Faces Specification Document, in the specified order. The processing flow can be affected (by the application, by components, or by event listeners) by calls to the renderResponse() or responseComplete() methods of the FacesContext instance associated with the current request. + jakarta.faces.lifecycle + LifecycleWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5571 + if thrown during the execution of the request processing lifecycle + jakarta.faces.lifecycle + LifecycleWrapper + + + jakarta.faces.context.FacesContext + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:5572 + Return the set of registered PhaseListeners for this Lifecycle instance. If there are no registered listeners, a zero-length array is returned. + jakarta.faces.lifecycle + LifecycleWrapper + + + + + JSF:JAVADOC:5573 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.lifecycle + LifecycleWrapper + + + + + JSF:JAVADOC:5574 + + jakarta.faces.lifecycle + LifecycleWrapper + + + + + JSF:JAVADOC:5575 + If this lifecycle has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.lifecycle + LifecycleWrapper + + + jakarta.faces.lifecycle.Lifecycle + + + + + + JSF:JAVADOC:5576 + Deregister an existing PhaseListener instance that is no longer interested in being notified before and after the processing for standard phases of the request processing lifecycle. If no such listener instance has been registered, no action is taken. + jakarta.faces.lifecycle + LifecycleWrapper + + + jakarta.faces.event.PhaseListener + + + + + + JSF:JAVADOC:5577 + Execute the Render Response phase of the request processing lifecycle, unless the responseComplete() method has been called on the FacesContext instance associated with the current request. + jakarta.faces.lifecycle + LifecycleWrapper + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5578 + if an exception is thrown during the execution of the request processing lifecycle + jakarta.faces.lifecycle + LifecycleWrapper + + + jakarta.faces.context.FacesContext + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:5579 + Construct a new ArrayDataModel with no specified wrapped data. + jakarta.faces.model + ArrayDataModel + + + + + JSF:JAVADOC:5580 + Construct a new ArrayDataModel wrapping the specified array. + jakarta.faces.model + ArrayDataModel + + + java.lang.Object[] + + + + + + JSF:JAVADOC:5581 + If there is wrappedData available, return the length of the array. If no wrappedData is available, return -1. + jakarta.faces.model + ArrayDataModel + + + + + JSF:JAVADOC:5582 + If row data is available, return the array element at the index specified by rowIndex. If no wrapped data is available, return null. + jakarta.faces.model + ArrayDataModel + + + + + JSF:JAVADOC:5583 + Return the zero-relative index of the currently selected row. If we are not currently positioned on a row, or no wrappedData is available, return -1. + jakarta.faces.model + ArrayDataModel + + + + + JSF:JAVADOC:5584 + Return the object representing the data wrapped by this DataModel, if any. + jakarta.faces.model + ArrayDataModel + + + + + JSF:JAVADOC:5585 + Return true if there is wrappedData available, and the current value of rowIndex is greater than or equal to zero, and less than the length of the array. Otherwise, return false. + jakarta.faces.model + ArrayDataModel + + + + + JSF:JAVADOC:5586 + Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row. It is possible to set the row index at a value for which the underlying data collection does not contain any row data. Therefore, callers may use the isRowAvailable() method to detect whether row data will be available for use by the getRowData() method. If there is no wrappedData available when this method is called, the specified rowIndex is stored (and may be retrieved by a subsequent call to getRowData()), but no event is sent. Otherwise, if the currently selected row index is changed by this call, a DataModelEvent will be sent to the rowSelected() method of all registered DataModelListeners. + jakarta.faces.model + ArrayDataModel + + + int + + + + + + JSF:JAVADOC:5587 + Set the object representing the data collection wrapped by this DataModel. If the specified data is null, detach this DataModel from any previously wrapped data collection instead. If data is non-null, the currently selected row index must be set to zero, and a DataModelEvent must be sent to the rowSelected() method of all registered DataModelListeners indicating that this row is now selected. + jakarta.faces.model + ArrayDataModel + + + java.lang.Object + + + + + + JSF:JAVADOC:5588 + Construct a new CollectionDataModel with no specified wrapped data. + jakarta.faces.model + CollectionDataModel + + + + + JSF:JAVADOC:5589 + Construct a new CollectionDataModel wrapping the specified list. + jakarta.faces.model + CollectionDataModel + + + java.util.Collection + + + + + + JSF:JAVADOC:5590 + If there is wrappedData available, return the length of the list. If no wrappedData is available, return -1. + jakarta.faces.model + CollectionDataModel + + + + + JSF:JAVADOC:5591 + If row data is available, return the array element at the index specified by rowIndex. If no wrapped data is available, return null. + jakarta.faces.model + CollectionDataModel + + + + + JSF:JAVADOC:5592 + Return the zero-relative index of the currently selected row. If we are not currently positioned on a row, or no wrappedData is available, return -1. + jakarta.faces.model + CollectionDataModel + + + + + JSF:JAVADOC:5593 + Return the object representing the data wrapped by this DataModel, if any. + jakarta.faces.model + CollectionDataModel + + + + + JSF:JAVADOC:5594 + Return true if there is wrappedData available, and the current value of rowIndex is greater than or equal to zero, and less than the size of the list. Otherwise, return false. + jakarta.faces.model + CollectionDataModel + + + + + JSF:JAVADOC:5595 + Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row. It is possible to set the row index at a value for which the underlying data collection does not contain any row data. Therefore, callers may use the isRowAvailable() method to detect whether row data will be available for use by the getRowData() method. If there is no wrappedData available when this method is called, the specified rowIndex is stored (and may be retrieved by a subsequent call to getRowData()), but no event is sent. Otherwise, if the currently selected row index is changed by this call, a DataModelEvent will be sent to the rowSelected() method of all registered DataModelListeners. + jakarta.faces.model + CollectionDataModel + + + int + + + + + + JSF:JAVADOC:5596 + Set the wrapped data. + jakarta.faces.model + CollectionDataModel + + + java.lang.Object + + + + + + JSF:JAVADOC:5597 + Add a new DataModelListener to the set interested in notifications from this DataModel. + jakarta.faces.model + DataModel + + + jakarta.faces.model.DataModelListener + + + + + + JSF:JAVADOC:5598 + + jakarta.faces.model + DataModel + + + + + JSF:JAVADOC:5599 + Return the set of DataModelListeners interested in notifications from this DataModel. If there are no such listeners, an empty array is returned. + jakarta.faces.model + DataModel + + + + + JSF:JAVADOC:5600 + Return the number of rows of data objects represented by this DataModel. If the number of rows is unknown, or no wrappedData is available, return -1. + jakarta.faces.model + DataModel + + + + + JSF:JAVADOC:5601 + Return an object representing the data for the currently selected row index. If no wrappedData is available, return null. + jakarta.faces.model + DataModel + + + + + JSF:JAVADOC:5602 + Return the zero-relative index of the currently selected row. If we are not currently positioned on a row, or no wrappedData is available, return -1. + jakarta.faces.model + DataModel + + + + + JSF:JAVADOC:5603 + Return the object representing the data wrapped by this DataModel, if any. + jakarta.faces.model + DataModel + + + + + JSF:JAVADOC:5604 + Return a flag indicating whether there is rowData available at the current rowIndex. If no wrappedData is available, return false. + jakarta.faces.model + DataModel + + + + + JSF:JAVADOC:5605 + Return a read-only Iterator over the row data for this model. + jakarta.faces.model + DataModel + + + + + JSF:JAVADOC:5606 + Remove an existing DataModelListener from the set interested in notifications from this DataModel. + jakarta.faces.model + DataModel + + + jakarta.faces.model.DataModelListener + + + + + + JSF:JAVADOC:5607 + Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row. It is possible to set the row index at a value for which the underlying data collection does not contain any row data. Therefore, callers may use the isRowAvailable() method to detect whether row data will be available for use by the getRowData() method. If there is no wrappedData available when this method is called, the specified rowIndex is stored (and may be retrieved by a subsequent call to getRowData()), but no event is sent. Otherwise, if the currently selected row index is changed by this call, a DataModelEvent will be sent to the rowSelected() method of all registered DataModelListeners. + jakarta.faces.model + DataModel + + + int + + + + + + JSF:JAVADOC:5608 + Set the object representing the data collection wrapped by this DataModel. If the specified data is null, detach this DataModel from any previously wrapped data collection instead. If data is non-null, the currently selected row index must be set to zero, and a DataModelEvent must be sent to the rowSelected() method of all registered DataModelListeners indicating that this row is now selected. + jakarta.faces.model + DataModel + + + java.lang.Object + + + + + + JSF:JAVADOC:5609 + Construct an event object that is associated with the specified row index and associated data. + jakarta.faces.model + DataModelEvent + + + jakarta.faces.model.DataModel + int + java.lang.Object + + + + + + JSF:JAVADOC:5610 + Return the DataModel that fired this event. + jakarta.faces.model + DataModelEvent + + + + + JSF:JAVADOC:5611 + Return the object representing the data for the specified row index, or null for no associated row data. + jakarta.faces.model + DataModelEvent + + + + + JSF:JAVADOC:5612 + Return the row index for this event, or -1 for no specific row. + jakarta.faces.model + DataModelEvent + + + + + JSF:JAVADOC:5613 + Notification that a particular row index, with the associated row data, has been selected for processing. + jakarta.faces.model + DataModelListener + + + jakarta.faces.model.DataModelEvent + + + + + + JSF:JAVADOC:5614 + The value of this annotation attribute is taken to be the type that the DataModel that is annotated with this annotation is able to wrap. + jakarta.faces.model + FacesDataModel + + + + + JSF:JAVADOC:5615 + The value of this annotation attribute is taken to be the type that the DataModel that is annotated with this annotation is able to wrap. + jakarta.faces.model + FacesDataModel.Literal + + + + + JSF:JAVADOC:5616 + + jakarta.faces.model + FacesDataModel.Literal + + + java.lang.Class + + + + + + JSF:JAVADOC:5617 + Return the number of rows of data objects represented by this DataModel. If the number of rows is unknown, or no wrappedData is available, return -1. + jakarta.faces.model + IterableDataModel + + + + + JSF:JAVADOC:5618 + Return an object representing the data for the currenty selected row index. If no wrappedData is available, return null. + jakarta.faces.model + IterableDataModel + + + + + JSF:JAVADOC:5619 + Return the zero-relative index of the currently selected row. If we are not currently positioned on a row, or no wrappedData is available, return -1. + jakarta.faces.model + IterableDataModel + + + + + JSF:JAVADOC:5620 + Return the object representing the data wrapped by this DataModel, if any. + jakarta.faces.model + IterableDataModel + + + + + JSF:JAVADOC:5621 + Return a flag indicating whether there is rowData available at the current rowIndex. If no wrappedData is available, return false. + jakarta.faces.model + IterableDataModel + + + + + JSF:JAVADOC:5622 + Construct a new IterableDataModel with no specified wrapped data. + jakarta.faces.model + IterableDataModel + + + + + JSF:JAVADOC:5623 + Construct a new IterableDataModel wrapping the specified iterable. + jakarta.faces.model + IterableDataModel + + + java.lang.Iterable + + + + + + JSF:JAVADOC:5624 + Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row. It is possible to set the row index at a value for which the underlying data collection does not contain any row data. Therefore, callers may use the isRowAvailable() method to detect whether row data will be available for use by the getRowData() method. If there is no wrappedData available when this method is called, the specified rowIndex is stored (and may be retrieved by a subsequent call to getRowData()), but no event is sent. Otherwise, if the currently selected row index is changed by this call, a DataModelEvent will be sent to the rowSelected() method of all registered DataModelListeners. + jakarta.faces.model + IterableDataModel + + + int + + + + + + JSF:JAVADOC:5625 + Set the object representing the data collection wrapped by this DataModel. If the specified data is null, detach this DataModel from any previously wrapped data collection instead. If data is non-null, the currently selected row index must be set to zero, and a DataModelEvent must be sent to the rowSelected() method of all registered DataModelListeners indicating that this row is now selected. + jakarta.faces.model + IterableDataModel + + + java.lang.Object + + + + + + JSF:JAVADOC:5626 + If there is wrappedData available, return the length of the list. If no wrappedData is available, return -1. + jakarta.faces.model + ListDataModel + + + + + JSF:JAVADOC:5627 + If row data is available, return the array element at the index specified by rowIndex. If no wrapped data is available, return null. + jakarta.faces.model + ListDataModel + + + + + JSF:JAVADOC:5628 + Return the zero-relative index of the currently selected row. If we are not currently positioned on a row, or no wrappedData is available, return -1. + jakarta.faces.model + ListDataModel + + + + + JSF:JAVADOC:5629 + Return the object representing the data wrapped by this DataModel, if any. + jakarta.faces.model + ListDataModel + + + + + JSF:JAVADOC:5630 + Return true if there is wrappedData available, and the current value of rowIndex is greater than or equal to zero, and less than the size of the list. Otherwise, return false. + jakarta.faces.model + ListDataModel + + + + + JSF:JAVADOC:5631 + Construct a new ListDataModel with no specified wrapped data. + jakarta.faces.model + ListDataModel + + + + + JSF:JAVADOC:5632 + Construct a new ListDataModel wrapping the specified list. + jakarta.faces.model + ListDataModel + + + java.util.List + + + + + + JSF:JAVADOC:5633 + Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row. It is possible to set the row index at a value for which the underlying data collection does not contain any row data. Therefore, callers may use the isRowAvailable() method to detect whether row data will be available for use by the getRowData() method. If there is no wrappedData available when this method is called, the specified rowIndex is stored (and may be retrieved by a subsequent call to getRowData()), but no event is sent. Otherwise, if the currently selected row index is changed by this call, a DataModelEvent will be sent to the rowSelected() method of all registered DataModelListeners. + jakarta.faces.model + ListDataModel + + + int + + + + + + JSF:JAVADOC:5634 + Set the object representing the data collection wrapped by this DataModel. If the specified data is null, detach this DataModel from any previously wrapped data collection instead. If data is non-null, the currently selected row index must be set to zero, and a DataModelEvent must be sent to the rowSelected() method of all registered DataModelListeners indicating that this row is now selected. + jakarta.faces.model + ListDataModel + + + java.lang.Object + + + + + + JSF:JAVADOC:5635 + Return -1, since ResultSet does not provide a standard way to determine the number of available rows without scrolling through the entire ResultSet, and this can be very expensive if the number of rows is large. + jakarta.faces.model + ResultSetDataModel + + + + + JSF:JAVADOC:5636 + If row data is available, return a Map representing the values of the columns for the row specified by rowIndex, keyed by the corresponding column names. If no wrapped data is available, return null. If a non-null Map is returned, its behavior must correspond to the contract for a mutable Map as described in the JavaDocs for AbstractMap, with the following exceptions and specialized behavior: The Map, and any supporting objects it returns, must perform all column name comparisons in a case-insensitive manner. This case-insensitivity must be implemented using a case-insensitive Comparator, such as String.CASE_INSENSITIVE_ORDER. The following methods must throw UnsupportedOperationException: clear(), remove(). The entrySet() method must return a Set that has the following behavior: Throw UnsupportedOperationException for any attempt to add or remove entries from the Set, either directly or indirectly through an Iterator returned by the Set. Updates to the value of an entry in this set must write through to the corresponding column value in the underlying ResultSet. The keySet() method must return a Set that throws UnsupportedOperationException on any attempt to add or remove keys, either directly or through an Iterator returned by the Set. The put() method must throw IllegalArgumentException if a key value for which containsKey() returns false is specified. However, if a key already present in the Map is specified, the specified value must write through to the corresponding column value in the underlying ResultSet. The values() method must return a Collection that throws UnsupportedOperationException on any attempt to add or remove values, either directly or through an Iterator returned by the Collection. + jakarta.faces.model + ResultSetDataModel + + + + + JSF:JAVADOC:5637 + Return the zero-relative index of the currently selected row. If we are not currently positioned on a row, or no wrappedData is available, return -1. + jakarta.faces.model + ResultSetDataModel + + + + + JSF:JAVADOC:5638 + Return the object representing the data wrapped by this DataModel, if any. + jakarta.faces.model + ResultSetDataModel + + + + + JSF:JAVADOC:5639 + Return true if there is wrappedData available, and the result of calling absolute() on the underlying ResultSet, passing the current value of rowIndex plus one (to account for the fact that ResultSet uses one-relative indexing), returns true. Otherwise, return false. + jakarta.faces.model + ResultSetDataModel + + + + + JSF:JAVADOC:5640 + Construct a new ResultSetDataModel with no specified wrapped data. + jakarta.faces.model + ResultSetDataModel + + + + + JSF:JAVADOC:5641 + Construct a new ResultSetDataModel wrapping the specified ResultSet. + jakarta.faces.model + ResultSetDataModel + + + java.sql.ResultSet + + + + + + JSF:JAVADOC:5642 + Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row. It is possible to set the row index at a value for which the underlying data collection does not contain any row data. Therefore, callers may use the isRowAvailable() method to detect whether row data will be available for use by the getRowData() method. If there is no wrappedData available when this method is called, the specified rowIndex is stored (and may be retrieved by a subsequent call to getRowData()), but no event is sent. Otherwise, if the currently selected row index is changed by this call, a DataModelEvent will be sent to the rowSelected() method of all registered DataModelListeners. + jakarta.faces.model + ResultSetDataModel + + + int + + + + + + JSF:JAVADOC:5643 + Set the object representing the data collection wrapped by this DataModel. If the specified data is null, detach this DataModel from any previously wrapped data collection instead. If data is non-null, the currently selected row index must be set to zero, and a DataModelEvent must be sent to the rowSelected() method of all registered DataModelListeners indicating that this row is now selected. + jakarta.faces.model + ResultSetDataModel + + + java.lang.Object + + + + + + JSF:JAVADOC:5644 + If there is wrappedData available, return 1. If no wrappedData is available, return -1. + jakarta.faces.model + ScalarDataModel + + + + + JSF:JAVADOC:5645 + If wrapped data is available, return the wrapped data instance. Otherwise, return null. + jakarta.faces.model + ScalarDataModel + + + + + JSF:JAVADOC:5646 + Return the zero-relative index of the currently selected row. If we are not currently positioned on a row, or no wrappedData is available, return -1. + jakarta.faces.model + ScalarDataModel + + + + + JSF:JAVADOC:5647 + Return the object representing the data wrapped by this DataModel, if any. + jakarta.faces.model + ScalarDataModel + + + + + JSF:JAVADOC:5648 + Return true if there is wrappedData available, and the current value of rowIndex is zero. Otherwise, return false. + jakarta.faces.model + ScalarDataModel + + + + + JSF:JAVADOC:5649 + Construct a new ScalarDataModel with no specified wrapped data. + jakarta.faces.model + ScalarDataModel + + + + + JSF:JAVADOC:5650 + Construct a new ScalarDataModel wrapping the specified scalar object. + jakarta.faces.model + ScalarDataModel + + + java.lang.Object + + + + + + JSF:JAVADOC:5651 + Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row. It is possible to set the row index at a value for which the underlying data collection does not contain any row data. Therefore, callers may use the isRowAvailable() method to detect whether row data will be available for use by the getRowData() method. If there is no wrappedData available when this method is called, the specified rowIndex is stored (and may be retrieved by a subsequent call to getRowData()), but no event is sent. Otherwise, if the currently selected row index is changed by this call, a DataModelEvent will be sent to the rowSelected() method of all registered DataModelListeners. + jakarta.faces.model + ScalarDataModel + + + int + + + + + + JSF:JAVADOC:5652 + Set the object representing the data collection wrapped by this DataModel. If the specified data is null, detach this DataModel from any previously wrapped data collection instead. If data is non-null, the currently selected row index must be set to zero, and a DataModelEvent must be sent to the rowSelected() method of all registered DataModelListeners indicating that this row is now selected. + jakarta.faces.model + ScalarDataModel + + + java.lang.Object + + + + + + JSF:JAVADOC:5653 + Return a description of this item, for use in development tools. + jakarta.faces.model + SelectItem + + + + + JSF:JAVADOC:5654 + Return the label of this item, to be rendered visibly for the user. + jakarta.faces.model + SelectItem + + + + + JSF:JAVADOC:5655 + Return the value of this item, to be delivered to the model if this item is selected by the user. + jakarta.faces.model + SelectItem + + + + + JSF:JAVADOC:5656 + Return the disabled flag for this item, which should modify the rendered output to make this item unavailable for selection by the user if set to true. + jakarta.faces.model + SelectItem + + + + + JSF:JAVADOC:5657 + If and only if this returns true, the code that renders this select item must escape the label using escaping syntax appropriate to the content type being rendered. + jakarta.faces.model + SelectItem + + + + + JSF:JAVADOC:5658 + Return the value of the noSelectionOption property. If the value of this property is true, the system interprets the option represented by this SelectItem instance as representing a "no selection" option. See UISelectOne#validateValue and UISelectMany#validateValue for usage. + jakarta.faces.model + SelectItem + + + + + JSF:JAVADOC:5659 + Construct a SelectItem with no initialized property values. + jakarta.faces.model + SelectItem + + + + + JSF:JAVADOC:5660 + Construct a SelectItem with the specified value. The label property will be set to the value (converted to a String, if necessary), the description property will be set to null, the disabled property will be set to false, and the escape property will be set to ( true. + jakarta.faces.model + SelectItem + + + java.lang.Object + + + + + + JSF:JAVADOC:5661 + Construct a SelectItem with the specified value and label. The description property will be set to null, the disabled property will be set to false, and the escape property will be set to true. + jakarta.faces.model + SelectItem + + + java.lang.Object + java.lang.String + + + + + + JSF:JAVADOC:5662 + Construct a SelectItem instance with the specified value, label and description. This disabled property will be set to false, and the escape property will be set to true. + jakarta.faces.model + SelectItem + + + java.lang.Object + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:5663 + Construct a SelectItem instance with the specified property values. The escape property will be set to true. + jakarta.faces.model + SelectItem + + + java.lang.Object + java.lang.String + java.lang.String + boolean + + + + + + JSF:JAVADOC:5664 + Construct a SelectItem instance with the specified property values. + jakarta.faces.model + SelectItem + + + java.lang.Object + java.lang.String + java.lang.String + boolean + boolean + + + + + + JSF:JAVADOC:5665 + Construct a SelectItem instance with the specified property values. + jakarta.faces.model + SelectItem + + + java.lang.Object + java.lang.String + java.lang.String + boolean + boolean + boolean + + + + + + JSF:JAVADOC:5666 + Set the description of this item, for use in development tools. + jakarta.faces.model + SelectItem + + + java.lang.String + + + + + + JSF:JAVADOC:5667 + Set the disabled flag for this item, which should modify the rendered output to make this item unavailable for selection by the user if set to true. + jakarta.faces.model + SelectItem + + + boolean + + + + + + JSF:JAVADOC:5668 + Set the value of the escape property. See #isEscape. + jakarta.faces.model + SelectItem + + + boolean + + + + + + JSF:JAVADOC:5669 + Set the label of this item, to be rendered visibly for the user. + jakarta.faces.model + SelectItem + + + java.lang.String + + + + + + JSF:JAVADOC:5670 + Set the value of the noSelectionOption property. + jakarta.faces.model + SelectItem + + + boolean + + + + + + JSF:JAVADOC:5671 + Set the value of this item, to be delivered to the model if this item is selected by this user. + jakarta.faces.model + SelectItem + + + java.lang.Object + + + + + + JSF:JAVADOC:5672 + Return the set of subordinate SelectItems for this group. + jakarta.faces.model + SelectItemGroup + + + + + JSF:JAVADOC:5673 + Construct a SelectItemGroup with no initialized property values. + jakarta.faces.model + SelectItemGroup + + + + + JSF:JAVADOC:5674 + Construct a SelectItemGroup with the specified label and no associated selectItems. The value property will be set to a zero-length String, the description property will be set to null, and the disabled property will be set to false. + jakarta.faces.model + SelectItemGroup + + + java.lang.String + + + + + + JSF:JAVADOC:5675 + Construct a SelectItemGroup with the specified properties. The value property will be set to a zero-length String. + jakarta.faces.model + SelectItemGroup + + + java.lang.String + java.lang.String + boolean + jakarta.faces.model.SelectItem[] + + + + + + JSF:JAVADOC:5676 + Construct a SelectItemGroup with the specified properties. The value property will be set to a zero-length String. + jakarta.faces.model + SelectItemGroup + + + java.lang.String + java.lang.String + boolean + java.util.Collection + + + + + + JSF:JAVADOC:5677 + Set the set of subordinate SelectItems for this group as a variable array. + jakarta.faces.model + SelectItemGroup + + + jakarta.faces.model.SelectItem[] + + + + + + JSF:JAVADOC:5678 + Set the set of subordinate SelectItems for this group as a collection. + jakarta.faces.model + SelectItemGroup + + + java.util.Collection + + + + + + JSF:JAVADOC:5679 + (Optional) The name of the push channel. If not specified the name of the injection target field will be used. + jakarta.faces.push + Push + + + + + JSF:JAVADOC:5680 + (Optional) The name of the push channel. If not specified the name of the injection target field will be used. + jakarta.faces.push + Push.Literal + + + + + JSF:JAVADOC:5681 + + jakarta.faces.push + Push.Literal + + + java.lang.String + + + + + + JSF:JAVADOC:5682 + Send given message object to the push socket channel as identified by #64;Push. The message object will be encoded as JSON and be available as first argument of the JavaScript listener function declared in . + jakarta.faces.push + PushContext + + + java.lang.Object + + + + + + JSF:JAVADOC:5683 + Send given message object to the push socket channel as identified by #64;Push, targeted to the given user as identified by . The message object will be encoded as JSON and be available as first argument of the JavaScript listener function declared in . + jakarta.faces.push + PushContext + + + java.lang.Object + java.io.Serializable + + + + + + JSF:JAVADOC:5684 + Send given message object to the push socket channel as identified by #64;Push, targeted to the given users as identified by . The message object will be encoded as JSON and be available as first argument of the JavaScript listener function declared in . + jakarta.faces.push + PushContext + + + java.lang.Object + java.util.Collection + + + + + + JSF:JAVADOC:5685 + + jakarta.faces.render + ClientBehaviorRenderer + + + + + JSF:JAVADOC:5686 + Decode any new state of this ClientBehavior from the request contained in the specified FacesContext. During decoding, events may be enqueued for later processing (by event listeners who have registered an interest), by calling queueEvent(). + jakarta.faces.render + ClientBehaviorRenderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + jakarta.faces.component.behavior.ClientBehavior + + + + + + JSF:JAVADOC:5687 + Return the script that implements this ClientBehavior's client-side logic. The default implementation returns null. ClientBehaviorRenderer.getScript() implementations are allowed to return null to indicate that no script is required for this particular getScript() call. For example, a ClientBehaviorRenderer implementation may return null if the associated ClientBehavior is disabled. + jakarta.faces.render + ClientBehaviorRenderer + + + jakarta.faces.component.behavior.ClientBehaviorContext + jakarta.faces.component.behavior.ClientBehavior + + + + + + JSF:JAVADOC:5688 + Within the RenderKit, the value of this annotation attribute is taken to be the renderer-type + jakarta.faces.render + FacesBehaviorRenderer + + + + + JSF:JAVADOC:5689 + The value of this annotation attribute is taken to be the render-kit-id in which an instance of this class of Renderer must be installed. + jakarta.faces.render + FacesBehaviorRenderer + + + + + JSF:JAVADOC:5690 + The value of this annotation attribute is taken to be the component-family which, in combination with #rendererType can be used to obtain a reference to an instance of this Renderer by calling jakarta.faces.render.RenderKit#getRenderer(java.lang.String, java.lang.String). + jakarta.faces.render + FacesRenderer + + + + + JSF:JAVADOC:5691 + The value of this annotation attribute is taken to be the renderer-type which, in combination with #componentFamily can be used to obtain a reference to an instance of this Renderer by calling jakarta.faces.render.RenderKit#getRenderer(java.lang.String, java.lang.String). + jakarta.faces.render + FacesRenderer + + + + + JSF:JAVADOC:5692 + The value of this annotation attribute is taken to be the render-kit-id in which an instance of this class of Renderer must be installed. + jakarta.faces.render + FacesRenderer + + + + + JSF:JAVADOC:5693 + Convert the component generated client id to a form suitable for transmission to the client. The default implementation returns the argument clientId unchanged. + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5694 + Attempt to convert previously stored state information into an object of the type required for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one). If conversion is successful, the new value should be returned from this method; if not, a ConverterException should be thrown. + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5695 + if the submitted value cannot be converted successfully. + jakarta.faces.render + Renderer + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + jakarta.faces.convert.ConverterException + + + + + JSF:JAVADOC:5696 + Return a flag indicating whether this Renderer is responsible for rendering the children the component it is asked to render. The default implementation returns false. + jakarta.faces.render + Renderer + + + + + JSF:JAVADOC:5697 + Convert the component generated client id to a form suitable for transmission to the client. The default implementation returns the argument clientId unchanged. + jakarta.faces.render + RendererWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5698 + Decode any new state of the specified UIComponent from the request contained in the specified FacesContext, and store that state on the UIComponent. During decoding, events may be enqueued for later processing (by event listeners that have registered an interest), by calling queueEvent() on the associated UIComponent. + jakarta.faces.render + RendererWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5699 + Render the beginning specified UIComponent to the output stream or writer associated with the response we are creating. If the conversion attempted in a previous call to getConvertedValue() for this component failed, the state information saved during execution of decode() should be used to reproduce the incorrect input. + jakarta.faces.render + RendererWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5700 + if an input/output error occurs while rendering + jakarta.faces.render + RendererWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.io.IOException + + + + + JSF:JAVADOC:5701 + Render the child components of this UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. This method will only be called if the rendersChildren property of this component is true. + jakarta.faces.render + RendererWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5702 + if an input/output error occurs while rendering + jakarta.faces.render + RendererWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.io.IOException + + + + + JSF:JAVADOC:5703 + Render the ending of the current state of the specified UIComponent, following the rules described for encodeBegin() to acquire the appropriate value to be rendered. + jakarta.faces.render + RendererWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5704 + if an input/output error occurs while rendering + jakarta.faces.render + RendererWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.io.IOException + + + + + JSF:JAVADOC:5705 + Attempt to convert previously stored state information into an object of the type required for this component (optionally using the registered jakarta.faces.convert.Converter for this component, if there is one). If conversion is successful, the new value should be returned from this method; if not, a ConverterException should be thrown. + jakarta.faces.render + RendererWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5706 + if the submitted value cannot be converted successfully. + jakarta.faces.render + RendererWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + jakarta.faces.convert.ConverterException + + + + + JSF:JAVADOC:5707 + Return a flag indicating whether this Renderer is responsible for rendering the children the component it is asked to render. The default implementation returns false. + jakarta.faces.render + RendererWrapper + + + + + JSF:JAVADOC:5708 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.render + RendererWrapper + + + + + JSF:JAVADOC:5709 + + jakarta.faces.render + RendererWrapper + + + + + JSF:JAVADOC:5710 + If this renderer has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.render + RendererWrapper + + + jakarta.faces.render.Renderer + + + + + + JSF:JAVADOC:5711 + Register the specified ClientBehaviorRenderer instance, associated with the specified component type, to the set of ClientBehaviorRenderers registered with this RenderKit, replacing any previously registered ClientBehaviorRenderer for this type. + jakarta.faces.render + RenderKit + + + java.lang.String + jakarta.faces.render.ClientBehaviorRenderer + + + + + + JSF:JAVADOC:5712 + Register the specified Renderer instance, associated with the specified component family and rendererType, to the set of Renderers registered with this RenderKit, replacing any previously registered Renderer for this combination of identifiers. + jakarta.faces.render + RenderKit + + + java.lang.String + java.lang.String + jakarta.faces.render.Renderer + + + + + + JSF:JAVADOC:5713 + Use the provided OutputStream to create a new ResponseStream instance. + jakarta.faces.render + RenderKit + + + java.io.OutputStream + + + + + + JSF:JAVADOC:5714 + Use the provided Writer to create a new ResponseWriter instance for the specified (optional) content type, and character encoding. Implementors are advised to consult the getCharacterEncoding() method of class jakarta.servlet.ServletResponse to get the required value for the characterEncoding for this method. Since the Writer for this response will already have been obtained (due to it ultimately being passed to this method), we know that the character encoding cannot change during the rendering of the response. + jakarta.faces.render + RenderKit + + + java.io.Writer + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:5715 + Return the ClientBehaviorRenderer instance most recently registered for the specified type, if any; otherwise, return null. + jakarta.faces.render + RenderKit + + + java.lang.String + + + + + + JSF:JAVADOC:5716 + Return an Iterator over the ClientBehaviorRenderer types. + jakarta.faces.render + RenderKit + + + + + JSF:JAVADOC:5717 + Return an Iterator over the component-family entries supported by this RenderKit instance. The default implementation of this method returns an empty Iterator + jakarta.faces.render + RenderKit + + + + + JSF:JAVADOC:5718 + Return the Renderer instance most recently registered for the specified component family and rendererType, if any; otherwise, return null. + jakarta.faces.render + RenderKit + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:5719 + Return an instance of ResponseStateManager to handle rendering technology specific state management decisions. + jakarta.faces.render + RenderKit + + + + + JSF:JAVADOC:5720 + Return a RenderKit instance for the specified render kit identifier, possibly customized based on dynamic characteristics of the specified FacesContext, if non-null. If there is no registered RenderKit for the specified identifier, return null. The set of available render kit identifiers is available via the getRenderKitIds() method. + jakarta.faces.render + RenderKitFactory + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5721 + If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped. + jakarta.faces.render + RenderKitFactory + + + + + JSF:JAVADOC:5722 + If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.render + RenderKitFactory + + + jakarta.faces.render.RenderKitFactory + + + + + + JSF:JAVADOC:5723 + The default behavior of this method is to call RenderKit#addClientBehaviorRenderer(String, ClientBehaviorRenderer) on the wrapped RenderKit object. + jakarta.faces.render + RenderKitWrapper + + + java.lang.String + jakarta.faces.render.ClientBehaviorRenderer + + + + + + JSF:JAVADOC:5724 + The default behavior of this method is to call RenderKit#addRenderer(String, String, Renderer) on the wrapped RenderKit object. + jakarta.faces.render + RenderKitWrapper + + + java.lang.String + java.lang.String + jakarta.faces.render.Renderer + + + + + + JSF:JAVADOC:5725 + The default behavior of this method is to call RenderKit#createResponseStream(java.io.OutputStream) on the wrapped RenderKit object. + jakarta.faces.render + RenderKitWrapper + + + java.io.OutputStream + + + + + + JSF:JAVADOC:5726 + The default behavior of this method is to call RenderKit#createResponseWriter(java.io.Writer, String, String) on the wrapped RenderKit object. + jakarta.faces.render + RenderKitWrapper + + + java.io.Writer + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:5727 + The default behavior of this method is to call RenderKit#getClientBehaviorRenderer(String) on the wrapped RenderKit object. + jakarta.faces.render + RenderKitWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:5728 + The default behavior of this method is to call jakarta.faces.render.RenderKit#getClientBehaviorRendererTypes() on the wrapped RenderKit object. + jakarta.faces.render + RenderKitWrapper + + + + + JSF:JAVADOC:5729 + The default behavior of this method is to call jakarta.faces.render.RenderKit#getComponentFamilies() on the wrapped RenderKit object. + jakarta.faces.render + RenderKitWrapper + + + + + JSF:JAVADOC:5730 + The default behavior of this method is to call RenderKit#getRenderer(String, String) on the wrapped RenderKit object. + jakarta.faces.render + RenderKitWrapper + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:5731 + The default behavior of this method is to call RenderKit#getRendererTypes(String) on the wrapped RenderKit object. + jakarta.faces.render + RenderKitWrapper + + + java.lang.String + + + + + + JSF:JAVADOC:5732 + The default behavior of this method is to call jakarta.faces.render.RenderKit#getResponseStateManager() on the wrapped RenderKit object. + jakarta.faces.render + RenderKitWrapper + + + + + JSF:JAVADOC:5733 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.render + RenderKitWrapper + + + + + JSF:JAVADOC:5734 + + jakarta.faces.render + RenderKitWrapper + + + + + JSF:JAVADOC:5735 + If this render kit has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.render + RenderKitWrapper + + + jakarta.faces.render.RenderKit + + + + + + JSF:JAVADOC:5736 + Compliant implementations must return a cryptographically strong token for use to protect views in this application. For backwards compatibility with earlier revisions, a default implementation is provided that simply returns null. + jakarta.faces.render + ResponseStateManager + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5737 + The implementation must inspect the current request and return an Object representing the tree structure and component state passed in to a previous invocation of #writeState(jakarta.faces.context.FacesContext,java.lang.Object). If the state saving method for this application is jakarta.faces.application.StateManager#STATE_SAVING_METHOD_CLIENT, writeState() will have encrypted the state in a tamper evident manner. If the state fails to decrypt, or decrypts but indicates evidence of tampering, a jakarta.faces.application.ProtectedViewException must be thrown. + jakarta.faces.render + ResponseStateManager + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5738 + Return the specified state as a String without any markup related to the rendering technology supported by this ResponseStateManager. + jakarta.faces.render + ResponseStateManager + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:5739 + Return true if the current request is a postback. This method is leveraged from the Restore View Phase to determine if jakarta.faces.application.ViewHandler#restoreView or jakarta.faces.application.ViewHandler#createView should be called. The default implementation must return true if this ResponseStateManager instance wrote out state on a previous request to which this request is a postback, false otherwise. The implementation of this method for the Standard HTML RenderKit must consult the jakarta.faces.context.ExternalContext's requestParameterMap and return true if and only if there is a key equal to the value of the symbolic constant #VIEW_STATE_PARAM. For backwards compatibility with implementations of ResponseStateManager prior to Jakarta Faces 1.2, a default implementation is provided that consults the jakarta.faces.context.ExternalContext's requestParameterMap and return true if its size is greater than 0. + jakarta.faces.render + ResponseStateManager + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5740 + If the preceding call to #writeState(jakarta.faces.context.FacesContext, java.lang.Object) was stateless, return true. If the preceding call to writeState() was stateful, return false. Otherwise throw IllegalStateException. To preserve backward compatibility with custom implementations that may have extended from an earlier version of this class, an implementation is provided that returns false. A compliant implementation must override this method to take the specified action. + jakarta.faces.render + ResponseStateManager + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5741 + + jakarta.faces.render + ResponseStateManager + + + + + JSF:JAVADOC:5742 + Take the argument state and write it into the output using the current ResponseWriter, which must be correctly positioned already. Call FacesContext#getViewRoot(). If jakarta.faces.component.UIComponent#isTransient() returns true, take implementation specific action so that the following call to #isStateless returns true and return. Otherwise, proceed as follows. If the state is to be written out to hidden fields, the implementation must take care to make all necessary character replacements to make the Strings suitable for inclusion as an HTTP request paramater. If the state saving method for this application is jakarta.faces.application.StateManager#STATE_SAVING_METHOD_CLIENT, the implementation must encrypt the state to be saved to the client in a tamper evident manner. If the state saving method for this application is jakarta.faces.application.StateManager#STATE_SAVING_METHOD_SERVER, and the current request is an Ajax request jakarta.faces.context.PartialViewContext#isAjaxRequest returns true), use the current view state identifier if it is available (do not generate a new identifier). Write out the render kit identifier associated with this ResponseStateManager implementation with the name as the value of the String constant ResponseStateManager.RENDER_KIT_ID_PARAM. The render kit identifier must not be written if: it is the default render kit identifier as returned by jakarta.faces.application.Application#getDefaultRenderKitId() or the render kit identfier is the value of jakarta.faces.render.RenderKitFactory.HTML_BASIC_RENDER_KIT and jakarta.faces.application.Application#getDefaultRenderKitId() returns null. The jakarta.faces.lifecycle.ClientWindow must be written using these steps. Call jakarta.faces.context.ExternalContext#getClientWindow. If the result is null, take no further action regarding the ClientWindow. If the result is non-null, write a hidden field whose name is #CLIENT_WINDOW_PARAM and whose id is jakarta.faces.ClientWindow where is the currently configured UINamingContainer.getSeparatorChar(). is the return from UIViewRoot.getContainerClientId() on the view from whence this state originated. is a number that must be unique within this view, but must not be included in the view state. The value of the field is implementation dependent but must uniquely identify this window within the user's session. + jakarta.faces.render + ResponseStateManager + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:5743 + if the state argument is not an array of length 2. + jakarta.faces.render + ResponseStateManager + + + jakarta.faces.context.FacesContext + java.lang.Object + + java.io.IOException + + + + + JSF:JAVADOC:5744 + + jakarta.faces.validator + BeanValidator + + + + + JSF:JAVADOC:5745 + Reset the PartialStateHolder to a non-delta tracking state. + jakarta.faces.validator + BeanValidator + + + + + JSF:JAVADOC:5746 + Return the validation groups passed to the Validation API when checking constraints. If the validationGroupsArray attribute is omitted or empty, the validation groups will be inherited from the branch defaults, or if there are no branch defaults, the jakarta.validation.groups.Default group will be used. + jakarta.faces.validator + BeanValidator + + + + + JSF:JAVADOC:5747 + Return true if delta state changes are being tracked, otherwise false + jakarta.faces.validator + BeanValidator + + + + + JSF:JAVADOC:5748 + + jakarta.faces.validator + BeanValidator + + + + + JSF:JAVADOC:5749 + The runtime must ensure that the #markInitialState method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state. The implementor of the interface must ensure that #initialStateMarked returns true from the time markInitialState() is called until #clearInitialState is called, after which time initialStateMarked() must return false. Also, during the time that the instance returns true from initialStateMarked(), the implementation must return only the state that has changed in its implementation of StateHolder#saveState. + jakarta.faces.validator + BeanValidator + + + + + JSF:JAVADOC:5750 + + jakarta.faces.validator + BeanValidator + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:5751 + + jakarta.faces.validator + BeanValidator + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5752 + + jakarta.faces.validator + BeanValidator + + + boolean + + + + + + JSF:JAVADOC:5753 + A comma-separated list of validation groups which are used to filter which validations get checked by this validator. If the validationGroupsArray attribute is omitted or is empty, the validation groups will be inherited from the branch defaults or, if there are no branch defaults, the jakarta.validation.groups.Default group will be used. + jakarta.faces.validator + BeanValidator + + + java.lang.String + + + + + + JSF:JAVADOC:5754 + Verify that the value is valid according to the Bean Validation constraints. Obtain a ValidatorFactory instance by calling jakarta.validation.Validation#buildDefaultValidatorFactory. Let validationGroupsArray be a Class [] representing validator groups set on the component by the tag handler for this validator. The first search component terminates the search for the validation groups value. If no such value is found use the class name of jakarta.validation.groups.Default as the value of the validation groups. Let valueExpression be the return from calling UIComponent#getValueExpression on the argument component, passing the literal string #8220;value #8221; (without the quotes) as an argument. If this application is running in an environment with Jakarta Expression Language, obtain the ValueReference from valueExpression and let valueBaseClase be the return from calling ValueReference.getBase() and valueProperty be the return from calling ValueReference.getProperty(). If an earlier version of Jakarta Expression Language is present, use the appropriate methods to inspect valueExpression and derive values for valueBaseClass and valueProperty. If no ValueReference can be obtained, take no action and return. If ValueReference.getBase() return null, take no action and return. Obtain the ValidatorContext from the ValidatorFactory. Decorate the MessageInterpolator returned from ValidatorFactory#getMessageInterpolator with one that leverages the Locale returned from jakarta.faces.component.UIViewRoot#getLocale, and store it in the ValidatorContext using ValidatorContext#messageInterpolator. Obtain the jakarta.validation.Validator instance from the validatorContext. Obtain a jakarta.validation.BeanDescriptor from the jakarta.validation.Validator. If hasConstraints() on the BeanDescriptor returns false, take no action and return. Otherwise proceed. Call jakarta.validation.Validator#validateValue, passing valueBaseClass, valueProperty, the value argument, and validatorGroupsArray as arguments. If the returned Set lt;ConstraintViolation gt; is non-empty, for each element in the Set, create a FacesMessage where the summary and detail are the return from calling ConstraintViolation#getMessage. Capture all such FacesMessage instances into a Collection and pass them to ValidatorException#ValidatorException(java.util.Collection). If the #ENABLE_VALIDATE_WHOLE_BEAN_PARAM_NAME application parameter is enabled and this Validator instance has validation groups other than or in addition to the Default group, record the fact that this field failed validation so that any component later in the tree is able to skip class-level validation for the bean for which this particular field is a property. Regardless of whether or not #ENABLE_VALIDATE_WHOLE_BEAN_PARAM_NAME is set, throw the new exception. If the returned Set is empty, the #ENABLE_VALIDATE_WHOLE_BEAN_PARAM_NAME application parameter is enabled and this Validator instance has validation groups other than or in addition to the Default group, record the fact that this field passed validation so that any component later in the tree is able to allow class-level validation for the bean for which this particular field is a property. + jakarta.faces.validator + BeanValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5755 + Reset the PartialStateHolder to a non-delta tracking state. + jakarta.faces.validator + DoubleRangeValidator + + + + + JSF:JAVADOC:5756 + Overrides the default equals method to take the minimum and maximum into account when comparing DoubleRangeValidator instances. + jakarta.faces.validator + DoubleRangeValidator + + + java.lang.Object + + + + + + JSF:JAVADOC:5757 + Overrides the default hash code method to take the minimum and maximum into account when generating the hash code. + jakarta.faces.validator + DoubleRangeValidator + + + + + JSF:JAVADOC:5758 + Return true if delta state changes are being tracked, otherwise false + jakarta.faces.validator + DoubleRangeValidator + + + + + JSF:JAVADOC:5759 + + jakarta.faces.validator + DoubleRangeValidator + + + + + JSF:JAVADOC:5760 + The runtime must ensure that the #markInitialState method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state. The implementor of the interface must ensure that #initialStateMarked returns true from the time markInitialState() is called until #clearInitialState is called, after which time initialStateMarked() must return false. Also, during the time that the instance returns true from initialStateMarked(), the implementation must return only the state that has changed in its implementation of StateHolder#saveState. + jakarta.faces.validator + DoubleRangeValidator + + + + + JSF:JAVADOC:5761 + + jakarta.faces.validator + DoubleRangeValidator + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:5762 + + jakarta.faces.validator + DoubleRangeValidator + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5763 + + jakarta.faces.validator + DoubleRangeValidator + + + boolean + + + + + + JSF:JAVADOC:5764 + + jakarta.faces.validator + DoubleRangeValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5765 + {@inheritDoc} + jakarta.faces.validator + DoubleRangeValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + jakarta.faces.validator.ValidatorException + + + + + JSF:JAVADOC:5766 + If true, the validator id for this annotation is added to the list of default validators by a call to jakarta.faces.application.Application#addDefaultValidatorId. + jakarta.faces.validator + FacesValidator + + + + + JSF:JAVADOC:5767 + The value of this annotation attribute is taken to be an indicator that flags whether or not the given converter is a CDI managed converter. + jakarta.faces.validator + FacesValidator + + + + + JSF:JAVADOC:5768 + The value of this annotation attribute is taken to be the validator-id with which instances of this class of component can be instantiated by calling jakarta.faces.application.Application#createValidator(java.lang.String). If no value is specified, or the value is null, the value is taken to be the return of calling getSimpleName on the class to which this annotation is attached and lowercasing the first character. If more than one validator with this derived name is found, the results are undefined. + jakarta.faces.validator + FacesValidator + + + + + JSF:JAVADOC:5769 + If true, the validator id for this annotation is added to the list of default validators by a call to jakarta.faces.application.Application#addDefaultValidatorId. + jakarta.faces.validator + FacesValidator.Literal + + + + + JSF:JAVADOC:5770 + The value of this annotation attribute is taken to be an indicator that flags whether or not the given converter is a CDI managed converter. + jakarta.faces.validator + FacesValidator.Literal + + + + + JSF:JAVADOC:5771 + + jakarta.faces.validator + FacesValidator.Literal + + + java.lang.String + boolean + boolean + + + + + + JSF:JAVADOC:5772 + The value of this annotation attribute is taken to be the validator-id with which instances of this class of component can be instantiated by calling jakarta.faces.application.Application#createValidator(java.lang.String). If no value is specified, or the value is null, the value is taken to be the return of calling getSimpleName on the class to which this annotation is attached and lowercasing the first character. If more than one validator with this derived name is found, the results are undefined. + jakarta.faces.validator + FacesValidator.Literal + + + + + JSF:JAVADOC:5773 + Reset the PartialStateHolder to a non-delta tracking state. + jakarta.faces.validator + LengthValidator + + + + + JSF:JAVADOC:5774 + + jakarta.faces.validator + LengthValidator + + + java.lang.Object + + + + + + JSF:JAVADOC:5775 + + jakarta.faces.validator + LengthValidator + + + + + JSF:JAVADOC:5776 + Return true if delta state changes are being tracked, otherwise false + jakarta.faces.validator + LengthValidator + + + + + JSF:JAVADOC:5777 + + jakarta.faces.validator + LengthValidator + + + + + JSF:JAVADOC:5778 + The runtime must ensure that the #markInitialState method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state. The implementor of the interface must ensure that #initialStateMarked returns true from the time markInitialState() is called until #clearInitialState is called, after which time initialStateMarked() must return false. Also, during the time that the instance returns true from initialStateMarked(), the implementation must return only the state that has changed in its implementation of StateHolder#saveState. + jakarta.faces.validator + LengthValidator + + + + + JSF:JAVADOC:5779 + + jakarta.faces.validator + LengthValidator + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:5780 + + jakarta.faces.validator + LengthValidator + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5781 + + jakarta.faces.validator + LengthValidator + + + boolean + + + + + + JSF:JAVADOC:5782 + + jakarta.faces.validator + LengthValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5783 + {@inheritDoc} + jakarta.faces.validator + LengthValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + jakarta.faces.validator.ValidatorException + + + + + JSF:JAVADOC:5784 + Reset the PartialStateHolder to a non-delta tracking state. + jakarta.faces.validator + LongRangeValidator + + + + + JSF:JAVADOC:5785 + + jakarta.faces.validator + LongRangeValidator + + + java.lang.Object + + + + + + JSF:JAVADOC:5786 + + jakarta.faces.validator + LongRangeValidator + + + + + JSF:JAVADOC:5787 + Return true if delta state changes are being tracked, otherwise false + jakarta.faces.validator + LongRangeValidator + + + + + JSF:JAVADOC:5788 + + jakarta.faces.validator + LongRangeValidator + + + + + JSF:JAVADOC:5789 + The runtime must ensure that the #markInitialState method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state. The implementor of the interface must ensure that #initialStateMarked returns true from the time markInitialState() is called until #clearInitialState is called, after which time initialStateMarked() must return false. Also, during the time that the instance returns true from initialStateMarked(), the implementation must return only the state that has changed in its implementation of StateHolder#saveState. + jakarta.faces.validator + LongRangeValidator + + + + + JSF:JAVADOC:5790 + + jakarta.faces.validator + LongRangeValidator + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:5791 + + jakarta.faces.validator + LongRangeValidator + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5792 + + jakarta.faces.validator + LongRangeValidator + + + boolean + + + + + + JSF:JAVADOC:5793 + + jakarta.faces.validator + LongRangeValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5794 + {@inheritDoc} + jakarta.faces.validator + LongRangeValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + jakarta.faces.validator.ValidatorException + + + + + JSF:JAVADOC:5795 + If true, the Object implementing this interface must not participate in state saving or restoring. + jakarta.faces.validator + MethodExpressionValidator + + + + + JSF:JAVADOC:5796 + + jakarta.faces.validator + MethodExpressionValidator + + + + + JSF:JAVADOC:5797 + Construct a Validator that contains a MethodExpression. + jakarta.faces.validator + MethodExpressionValidator + + + jakarta.el.MethodExpression + + + + + + JSF:JAVADOC:5798 + Perform any processing required to restore the state from the entries in the state Object. If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the #restoreState method on all those instances as well. If the state argument is null, take no action and return. + jakarta.faces.validator + MethodExpressionValidator + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:5799 + Gets the state of the instance as a Serializable Object. If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the #saveState method on all those instances as well. This method must not save the state of children and facets. That is done via the jakarta.faces.application.StateManager This method must not alter the state of the implementing object. In other words, after executing this code: Object state = component.saveState(facesContext); component should be the same as before executing it. The return from this method must be Serializable + jakarta.faces.validator + MethodExpressionValidator + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5800 + Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring. + jakarta.faces.validator + MethodExpressionValidator + + + boolean + + + + + + JSF:JAVADOC:5801 + + jakarta.faces.validator + MethodExpressionValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5802 + {@inheritDoc} + jakarta.faces.validator + MethodExpressionValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + jakarta.faces.validator.ValidatorException + + + + + JSF:JAVADOC:5803 + Reset the PartialStateHolder to a non-delta tracking state. + jakarta.faces.validator + RegexValidator + + + + + JSF:JAVADOC:5804 + Return the ValueExpression that yields the regular expression pattern when evaluated. + jakarta.faces.validator + RegexValidator + + + + + JSF:JAVADOC:5805 + Return true if delta state changes are being tracked, otherwise false + jakarta.faces.validator + RegexValidator + + + + + JSF:JAVADOC:5806 + + jakarta.faces.validator + RegexValidator + + + + + JSF:JAVADOC:5807 + The runtime must ensure that the #markInitialState method is called on each instance of this interface in the view at the appropriate time to indicate the component is in its initial state. The implementor of the interface must ensure that #initialStateMarked returns true from the time markInitialState() is called until #clearInitialState is called, after which time initialStateMarked() must return false. Also, during the time that the instance returns true from initialStateMarked(), the implementation must return only the state that has changed in its implementation of StateHolder#saveState. + jakarta.faces.validator + RegexValidator + + + + + JSF:JAVADOC:5808 + + jakarta.faces.validator + RegexValidator + + + + + JSF:JAVADOC:5809 + + jakarta.faces.validator + RegexValidator + + + jakarta.faces.context.FacesContext + java.lang.Object + + + + + + JSF:JAVADOC:5810 + + jakarta.faces.validator + RegexValidator + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5811 + The Regular Expression property to validate against. + jakarta.faces.validator + RegexValidator + + + java.lang.String + + + + + + JSF:JAVADOC:5812 + + jakarta.faces.validator + RegexValidator + + + boolean + + + + + + JSF:JAVADOC:5813 + Validate a String against a regular expression pattern. The full regex pattern must be matched in order to pass the validation. + jakarta.faces.validator + RegexValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5814 + Verify that the converted object value is not null. + jakarta.faces.validator + RequiredValidator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5815 + Perform the correctness checks implemented by this Validator against the specified UIComponent. If any violations are found, a ValidatorException will be thrown containing the jakarta.faces.application.FacesMessage describing the failure. For a validator to be fully compliant with Version 2 and later of the specification, it must not fail validation on null or empty values unless it is specifically intended to address null or empty values. An application-wide is provided to allow validators designed for Jakarta Faces 1.2 to work with Jakarta Faces 2 and later. The jakarta.faces.VALIDATE_EMPTY_FIELDS must be set to false to enable this backwards compatibility behavior. + jakarta.faces.validator + Validator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + + + + + JSF:JAVADOC:5816 + if validation fails + jakarta.faces.validator + Validator + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.lang.Object + + jakarta.faces.validator.ValidatorException + + + + + JSF:JAVADOC:5817 + Returns the FacesMessage associated with the exception. If this instance was created with a constructor that takes Collection, this method returns the first message in the Collection + jakarta.faces.validator + ValidatorException + + + + + JSF:JAVADOC:5818 + If this instance was created with a constructor that takes Collection, this method returns the passed collection, otherwise this method returns null. + jakarta.faces.validator + ValidatorException + + + + + JSF:JAVADOC:5819 + Construct a new exception with the specified message and no root cause. + jakarta.faces.validator + ValidatorException + + + jakarta.faces.application.FacesMessage + + + + + + JSF:JAVADOC:5820 + Allow this one exception to contain multiple messages. + jakarta.faces.validator + ValidatorException + + + java.util.Collection + + + + + + JSF:JAVADOC:5821 + Construct a new exception with the specified detail message and root cause. + jakarta.faces.validator + ValidatorException + + + jakarta.faces.application.FacesMessage + java.lang.Throwable + + + + + + JSF:JAVADOC:5822 + Allow this one exception to contain multiple messages, while passing on the root cause to the superclass + jakarta.faces.validator + ValidatorException + + + java.util.Collection + java.lang.Throwable + + + + + + JSF:JAVADOC:5823 + Take the argument parent and apply this attached object to it. The action taken varies with class that implements one of the subinterfaces of this interface. + jakarta.faces.view + AttachedObjectHandler + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5824 + Return the value of the "for" attribute specified by the page author on the tag for this AttachedObjectHandler. + jakarta.faces.view + AttachedObjectHandler + + + + + JSF:JAVADOC:5825 + Returns the name by which this attached object target is exposed to the page author. + jakarta.faces.view + AttachedObjectTarget + + + + + JSF:JAVADOC:5826 + Returns the List that this AttachedObjectTarget exposes. Each attached object exposed by the composite component author may point at multiple UIComponent instances within the composite component. This method is used by the jakarta.faces.view.ViewDeclarationLanguage#retargetAttachedObjects method to take the appropriate action on the attached object. + jakarta.faces.view + AttachedObjectTarget + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5827 + Return the client event name to which this behavior applies. + jakarta.faces.view + BehaviorHolderAttachedObjectHandler + + + + + JSF:JAVADOC:5828 + Returns whether the event set on this target is the default event, e.g. as set by a tag via the "default" attribute. + jakarta.faces.view + BehaviorHolderAttachedObjectTarget + + + + + JSF:JAVADOC:5829 + Return the estimated character column. + jakarta.faces.view + Location + + + + + JSF:JAVADOC:5830 + Return the line number in the page for this location. + jakarta.faces.view + Location + + + + + JSF:JAVADOC:5831 + Return the file path to the page represented by this location. + jakarta.faces.view + Location + + + + + JSF:JAVADOC:5832 + + jakarta.faces.view + Location + + + java.lang.String + int + int + + + + + + JSF:JAVADOC:5833 + + jakarta.faces.view + Location + + + + + JSF:JAVADOC:5834 + Restore the state of the view with information in the request. The default implementation must perform the following algorithm or its semantic equivalent. As in the case of restore view on an initial request, the view metadata must be restored and properly handled as well. Obtain the ViewMetadata for the current viewId, and from that call ViewMetadata#createMetadataView. Store the resultant UIViewRoot in the FacesContext. Obtain the state of the UIViewRoot from the state Object returned from jakarta.faces.render.ResponseStateManager#getState and pass that to UIViewRoot#restoreViewScopeState. Build the view from the markup. For all components in the view that do not have an explicitly assigned id in the markup, the values of those ids must be the same as on an initial request for this view. This view will not contain any components programmatically added during the previous lifecycle run, and it will contain components that were programmatically deleted on the previous lifecycle run. Both of these cases must be handled. Call jakarta.faces.render.ResponseStateManager#getState to obtain the data structure returned from the previous call to #saveView. Visit the tree using jakarta.faces.component.UIComponent#visitTree. For each node, call jakarta.faces.component.UIComponent#restoreState, passing the state saved corresponding to the current client id. Ensure that any programmatically deleted components are removed. Ensure any programmatically added components are added. The implementation must ensure that the jakarta.faces.component.UIComponent#restoreState method is called for each node in the tree, except for those that were programmatically deleted on the previous run through the lifecycle. + jakarta.faces.view + StateManagementStrategy + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:5835 + Return the state of the current view in an Object that implements Serializable and can be passed to java.io.ObjectOutputStream.writeObject() without causing a java.io.NotSerializableException to be thrown. The default implementation must perform the following algorithm or its semantic equivalent, explicitly performing all the steps listed here. If the UIViewRoot of the current view is marked transient, return null immediately. Traverse the view and verify that each of the client ids are unique. Throw IllegalStateException if more than one client id are the same. Visit the tree using jakarta.faces.component.UIComponent#visitTree. For each node, call jakarta.faces.component.UIComponent#saveState, saving the returned Object in a way such that it can be restored given only its client id. Special care must be taken to handle the case of components that were added or deleted programmatically during this lifecycle traversal, rather than by the VDL. The implementation must ensure that the jakarta.faces.component.UIComponent#saveState method is called for each node in the tree. The data structure used to save the state obtained by executing the above algorithm must be Serializable, and all of the elements within the data structure must also be Serializable. + jakarta.faces.view + StateManagementStrategy + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5836 + + jakarta.faces.view + StateManagementStrategy + + + + + JSF:JAVADOC:5837 + Take any actions specific to this VDL implementation to cause the argument UIViewRoot which must have been created via a call to #createView, to be populated with children. The Facelets implementation must insure that markup comprising the view must be executed, with the jakarta.faces.component.UIComponent instances in the view being encountered in the same depth-first order as in other lifecycle methods defined on UIComponent, and added to the view (but not rendered) during the traversal. The runtime must guarantee that the view must be fully populated before any of the following happen. The jakarta.faces.event.PhaseListener#afterPhase method of any PhaseListeners attached to the application is called The jakarta.faces.component.UIViewRoot phase listener installed via jakarta.faces.component.UIViewRoot#setAfterPhaseListener or jakarta.faces.component.UIViewRoot#addPhaseListener are called. If the root is already populated with children, the view must still be re-built, but care must be taken to ensure that the existing components are correctly paired up with their VDL counterparts in the VDL page. Also, any system events that would normally be generated during the adding or removing of components from the view must be temporarily disabled during the creation of the view and then re-enabled when the view has been built. + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:5838 + if view cannot be built for any reason + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + java.io.IOException + + + + + JSF:JAVADOC:5839 + Return the list of resource library contracts that will be made available for use in the view specified by the argument viewId. If no match is found, return an empty list. See section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the specification of the default implementation. For backward compatibility with prior implementations, an implementation is provided that returns null, but any implementation compliant with the version of the specification in which this method was introduced must implement it as specified in section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document. + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5840 + Create a component given a ViewDeclarationLanguage specific tag library URI and tag name. The runtime must support this method operating for the Facelets VDL. Other kinds of ViewDeclarationLanguage may be supported but are not required to be supported. For backward compatibility with decorated ViewDeclrationLanguage implementations that do not override this method, a default implementation is provided that returns null. However, any implementation that is compliant with the version of the specification in which this method was introduced must implement this method. + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + java.util.Map + + + + + + JSF:JAVADOC:5841 + Create a UIViewRoot from the VDL contained in the artifact referenced by the argument viewId. See section 7.7.2"Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the specification of the default implementation. + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5842 + Return a reference to the component metadata for the composite component represented by the argument componentResource, or null if the metadata cannot be found. See section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the specification of the default implementation. Jakarta Server Pages implementations must throw UnsupportedOperationException. + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + jakarta.faces.application.Resource + + + + + + JSF:JAVADOC:5843 + Returns a non-null String that can be used to identify this view declaration language. The default implementation returns the fully qualified class name of the view declaration language implementation. Subclasses may override to provide a more meaningful id. + jakarta.faces.view + ViewDeclarationLanguage + + + + + JSF:JAVADOC:5844 + Take implementation specific action to discover a Resource given the argument componentResource. See section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the specification of the default implementation. Jakarta Server Pages implementations must throw UnsupportedOperationException. + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + jakarta.faces.application.Resource + + + + + + JSF:JAVADOC:5845 + For implementations that want to control the implementation of state saving and restoring, the StateManagementStrategy allows them to do so. Returning null indicates that the implementation wishes the runtime to handle the state saving and restoring. Implementations that provide the VDL for Facelets for Jakarta Faces 2.0 and later must return non-null from this method. + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5846 + Return a reference to the view metadata for the view represented by the argument viewId, or null if the metadata cannot be found. See section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the specification of the default implementation. Facelets implementation must return non-null. + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5847 + Return a Stream possibly lazily populated by walking the view tree rooted at a given initial path. The view tree is traversed breadth-first, the elements in the stream are logical view ids. This method works as if invoking it were equivalent to evaluating the expression: getViewResources(facesContext, start, Integer.MAX_VALUE, options) Put differently, it visits all levels of the resource tree. + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + java.lang.String + jakarta.faces.application.ViewVisitOption[] + + + + + + JSF:JAVADOC:5848 + Return a Stream possibly lazily populated by walking the view tree rooted at a given initial path. The view tree is traversed breadth-first, the elements in the stream are logical view ids. The maxDepth parameter is the maximum depth of directory levels to visit beyond the initial path, which is always visited. The value is relative to the root (/), not to the given initial path. E.g. given maxDepth = 3 and initial path /foo/, visiting will proceed up to /foo/bar/, where / counts as depth 1, /foo/ as depth 2 and /foo/bar/ as depth 3. A value lower or equal to the depth of the initial path means that only the initial path is visited. A value of Integer#MAX_VALUE MAX_VALUE may be used to indicate that all levels should be visited. + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + java.lang.String + int + jakarta.faces.application.ViewVisitOption[] + + + + + + JSF:JAVADOC:5849 + Render a view rooted at argumentview. See section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the specification of the default implementation. + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:5850 + if the view cannot be rendered for any reason + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + java.io.IOException + + + + + JSF:JAVADOC:5851 + Restore a UIViewRoot from a previously created view. See section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the specification of the default implementation. + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5852 + Assuming the component metadata for argument topLevelComponent has been made available by an earlier call to ViewDeclarationLanguage#getComponentMetadata, leverage the component metadata for the purpose of re-targeting attached objects from the top level composite component to the individual AttachedObjectTarget instances inside the composite component. This method must be called by the ViewDeclarationLanguage implementation when creating the UIComponent tree when a composite component usage is encountered. An algorithm semantically equivalent to the following must be implemented. Obtain the metadata for the composite component. Currently this entails getting the value of the UIComponent#BEANINFO_KEY component attribute, which will be an instance of BeanInfo. If the metadata cannot be found, log an error message and return. Get the BeanDescriptor from the BeanInfo. Get the value of the AttachedObjectTarget#ATTACHED_OBJECT_TARGETS_KEY from the BeanDescriptor's getValue() method. This will be a List lt;AttachedObjectTarget gt;. Let this be targetList. For each curHandler entry in the argument handlers Let forAttributeValue be the return from AttachedObjectHandler#getFor. For each curTarget entry in targetList, the first of the following items that causes a match will take this action: For each UIComponent in the list returned from curTarget.getTargets(), call curHandler.applyAttachedObject(), passing the FacesContext and the UIComponent. and cause this inner loop to terminate. If curHandler is an instance of ActionSource2AttachedObjectHandler and curTarget is an instance of ActionSource2AttachedObjectTarget, and curTarget.getName() is equal to curTargetName, consider it a match. If curHandler is an instance of EditableValueHolderAttachedObjectHandler and curTarget is an instance of EditableValueHolderAttachedObjectTarget, and curTarget.getName() is equal to curTargetName, consider it a match. If curHandler is an instance of ValueHolderAttachedObjectHandler and curTarget is an instance of ValueHolderAttachedObjectTarget, and curTarget.getName() is equal to curTargetName, consider it a match. If curHandler is an instance of BehaviorHolderAttachedObjectHandler and curTarget is an instance of BehaviorHolderAttachedObjectTarget, and either of the following conditions are true, curHandler.getEventName() is not null and is equal to curTargetName. curHandler.getEventName() is null and curTarget.isDefaultEvent() is true. consider it a match. The implementation must support retargeting attached objects from the top level compsite component to targets that are composite and non-composite components. An implementation is provided that will throw UnsupportedOperationException. A Faces implementation compliant with version 2.0 and beyond of the specification must override this method. + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.util.List + + + + + + JSF:JAVADOC:5853 + Assuming the component metadata for argument topLevelComponent has been made available by an earlier call to ViewDeclarationLanguage#getComponentMetadata, leverage the component metadata for the purpose of re-targeting any method expressions from the top level component to the appropriate inner component. For each attribute that is a MethodExpression (as indicated by the presence of a "method-signature" attribute and the absence of a "type" attribute), the following action must be taken: Get the value of the targets attribute. If the value is a ValueExpression evaluate it. If there is no targets attribute, let the name of the metadata element be the evaluated value of the targets attribute. Interpret targets as a space (not tab) separated list of ids. For each entry in the list: Find the inner component of the topLevelComponent with the id equal to the current list entry. For discussion, this component is called target. If not found, log and error and continue to the next attribute. For discussion the declared name of the attribute is called name. In the attributes map of the topLevelComponent, look up the entry under the key name. Assume the result is a ValueExpression. For discussion, this is attributeValueExpression. If not found, log an error and continue to the next attribute. If name is equal to the string "action", or "actionListener" without the quotes, assume target is an jakarta.faces.component.ActionSource2. If name is equal to the string "validator", or "valueChangeListener" without the quotes, assume target is an jakarta.faces.component.EditableValueHolder. Call getExpressionString() on the attributeValueExpression and use that string to create a MethodExpression of the appropriate signature for name. If name is not equal to any of the previously listed strings, call getExpressionString() on the attributeValueExpression and use that string to create a MethodExpression where the signature is created based on the value of the "method-signature" attribute of the tag. Let the resultant MethodExpression be called attributeMethodExpression for discussion. If name is equal to the string "action" without the quotes, call jakarta.faces.component.ActionSource2#setActionExpression on target, passing attributeMethodExpression. If name is equal to the string "actionListener" without the quotes, call jakarta.faces.component.ActionSource#addActionListener on target, passing attributeMethodExpression wrapped in a jakarta.faces.event.MethodExpressionActionListener. If name is equal to the string "validator" without the quotes, call jakarta.faces.component.EditableValueHolder#addValidator on target, passing attributeMethodExpression wrapped in a jakarta.faces.validator.MethodExpressionValidator. If name is equal to the string "valueChangeListener" without the quotes, call jakarta.faces.component.EditableValueHolder#addValueChangeListener on target, passing attributeMethodExpression wrapped in a jakarta.faces.event.MethodExpressionValueChangeListener. Otherwise, assume that the MethodExpression should be placed in the components attribute set. The runtme must create the MethodExpression instance based on the value of the "method-signature" attribute. An implementation is provided that will throw UnsupportedOperationException. A Faces implementation compliant with version 2.0 and beyond of the specification must override this method. + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5854 + + jakarta.faces.view + ViewDeclarationLanguage + + + + + JSF:JAVADOC:5855 + Tests whether a physical resource corresponding to the specified viewId exists. The default implementation uses jakarta.faces.application.ResourceHandler#createViewResource to locate the physical resource. + jakarta.faces.view + ViewDeclarationLanguage + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5856 + Gets the list of all view declaration languages supported by this runtime. + jakarta.faces.view + ViewDeclarationLanguageFactory + + + + + JSF:JAVADOC:5857 + Return the ViewDeclarationLanguage instance suitable for handling the VDL contained in the page referenced by the argument viewId. The default implementation must return a valid ViewDeclarationLanguage instance for views written in either Jakarta Server Pages, Faces XML Views, or Facelets for Jakarta Faces 2. + jakarta.faces.view + ViewDeclarationLanguageFactory + + + java.lang.String + + + + + + JSF:JAVADOC:5858 + If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped. + jakarta.faces.view + ViewDeclarationLanguageFactory + + + + + JSF:JAVADOC:5859 + + jakarta.faces.view + ViewDeclarationLanguageFactory + + + + + JSF:JAVADOC:5860 + If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.view + ViewDeclarationLanguageFactory + + + jakarta.faces.view.ViewDeclarationLanguageFactory + + + + + + JSF:JAVADOC:5861 + Take any actions specific to this VDL implementation to cause the argument UIViewRoot which must have been created via a call to #createView, to be populated with children. The Facelets implementation must insure that markup comprising the view must be executed, with the jakarta.faces.component.UIComponent instances in the view being encountered in the same depth-first order as in other lifecycle methods defined on UIComponent, and added to the view (but not rendered) during the traversal. The runtime must guarantee that the view must be fully populated before any of the following happen. The jakarta.faces.event.PhaseListener#afterPhase method of any PhaseListeners attached to the application is called The jakarta.faces.component.UIViewRoot phase listener installed via jakarta.faces.component.UIViewRoot#setAfterPhaseListener or jakarta.faces.component.UIViewRoot#addPhaseListener are called. If the root is already populated with children, the view must still be re-built, but care must be taken to ensure that the existing components are correctly paired up with their VDL counterparts in the VDL page. Also, any system events that would normally be generated during the adding or removing of components from the view must be temporarily disabled during the creation of the view and then re-enabled when the view has been built. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:5862 + if view cannot be built for any reason + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + java.io.IOException + + + + + JSF:JAVADOC:5863 + Return the list of resource library contracts that will be made available for use in the view specified by the argument viewId. If no match is found, return an empty list. See section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the specification of the default implementation. For backward compatibility with prior implementations, an implementation is provided that returns null, but any implementation compliant with the version of the specification in which this method was introduced must implement it as specified in section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5864 + Create a component given a ViewDeclarationLanguage specific tag library URI and tag name. The runtime must support this method operating for the Facelets VDL. Other kinds of ViewDeclarationLanguage may be supported but are not required to be supported. For backward compatibility with decorated ViewDeclrationLanguage implementations that do not override this method, a default implementation is provided that returns null. However, any implementation that is compliant with the version of the specification in which this method was introduced must implement this method. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + java.lang.String + java.util.Map + + + + + + JSF:JAVADOC:5865 + Create a UIViewRoot from the VDL contained in the artifact referenced by the argument viewId. See section 7.7.2"Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the specification of the default implementation. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5866 + Return a reference to the component metadata for the composite component represented by the argument componentResource, or null if the metadata cannot be found. See section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the specification of the default implementation. Jakarta Server Pages implementations must throw UnsupportedOperationException. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.application.Resource + + + + + + JSF:JAVADOC:5867 + Returns a non-null String that can be used to identify this view declaration language. The default implementation returns the fully qualified class name of the view declaration language implementation. Subclasses may override to provide a more meaningful id. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + + + JSF:JAVADOC:5868 + Take implementation specific action to discover a Resource given the argument componentResource. See section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the specification of the default implementation. Jakarta Server Pages implementations must throw UnsupportedOperationException. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.application.Resource + + + + + + JSF:JAVADOC:5869 + For implementations that want to control the implementation of state saving and restoring, the StateManagementStrategy allows them to do so. Returning null indicates that the implementation wishes the runtime to handle the state saving and restoring. Implementations that provide the VDL for Facelets for Jakarta Faces 2.0 and later must return non-null from this method. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5870 + Return a reference to the view metadata for the view represented by the argument viewId, or null if the metadata cannot be found. See section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the specification of the default implementation. Facelets implementation must return non-null. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5871 + Return a Stream possibly lazily populated by walking the view tree rooted at a given initial path. The view tree is traversed breadth-first, the elements in the stream are logical view ids. This method works as if invoking it were equivalent to evaluating the expression: getViewResources(facesContext, start, Integer.MAX_VALUE, options) Put differently, it visits all levels of the resource tree. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + jakarta.faces.application.ViewVisitOption[] + + + + + + JSF:JAVADOC:5872 + Return a Stream possibly lazily populated by walking the view tree rooted at a given initial path. The view tree is traversed breadth-first, the elements in the stream are logical view ids. The maxDepth parameter is the maximum depth of directory levels to visit beyond the initial path, which is always visited. The value is relative to the root (/), not to the given initial path. E.g. given maxDepth = 3 and initial path /foo/, visiting will proceed up to /foo/bar/, where / counts as depth 1, /foo/ as depth 2 and /foo/bar/ as depth 3. A value lower or equal to the depth of the initial path means that only the initial path is visited. A value of Integer#MAX_VALUE MAX_VALUE may be used to indicate that all levels should be visited. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + int + jakarta.faces.application.ViewVisitOption[] + + + + + + JSF:JAVADOC:5873 + A class that implements this interface uses this method to return an instance of the class being wrapped. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + + + JSF:JAVADOC:5874 + Render a view rooted at argumentview. See section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the specification of the default implementation. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:5875 + if the view cannot be rendered for any reason + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIViewRoot + + java.io.IOException + + + + + JSF:JAVADOC:5876 + Restore a UIViewRoot from a previously created view. See section 7.7.2 "Default ViewDeclarationLanguage Implementation" of the Jakarta Faces Specification Document for the specification of the default implementation. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5877 + Assuming the component metadata for argument topLevelComponent has been made available by an earlier call to ViewDeclarationLanguage#getComponentMetadata, leverage the component metadata for the purpose of re-targeting attached objects from the top level composite component to the individual AttachedObjectTarget instances inside the composite component. This method must be called by the ViewDeclarationLanguage implementation when creating the UIComponent tree when a composite component usage is encountered. An algorithm semantically equivalent to the following must be implemented. Obtain the metadata for the composite component. Currently this entails getting the value of the UIComponent#BEANINFO_KEY component attribute, which will be an instance of BeanInfo. If the metadata cannot be found, log an error message and return. Get the BeanDescriptor from the BeanInfo. Get the value of the AttachedObjectTarget#ATTACHED_OBJECT_TARGETS_KEY from the BeanDescriptor's getValue() method. This will be a List lt;AttachedObjectTarget gt;. Let this be targetList. For each curHandler entry in the argument handlers Let forAttributeValue be the return from AttachedObjectHandler#getFor. For each curTarget entry in targetList, the first of the following items that causes a match will take this action: For each UIComponent in the list returned from curTarget.getTargets(), call curHandler.applyAttachedObject(), passing the FacesContext and the UIComponent. and cause this inner loop to terminate. If curHandler is an instance of ActionSource2AttachedObjectHandler and curTarget is an instance of ActionSource2AttachedObjectTarget, and curTarget.getName() is equal to curTargetName, consider it a match. If curHandler is an instance of EditableValueHolderAttachedObjectHandler and curTarget is an instance of EditableValueHolderAttachedObjectTarget, and curTarget.getName() is equal to curTargetName, consider it a match. If curHandler is an instance of ValueHolderAttachedObjectHandler and curTarget is an instance of ValueHolderAttachedObjectTarget, and curTarget.getName() is equal to curTargetName, consider it a match. If curHandler is an instance of BehaviorHolderAttachedObjectHandler and curTarget is an instance of BehaviorHolderAttachedObjectTarget, and either of the following conditions are true, curHandler.getEventName() is not null and is equal to curTargetName. curHandler.getEventName() is null and curTarget.isDefaultEvent() is true. consider it a match. The implementation must support retargeting attached objects from the top level compsite component to targets that are composite and non-composite components. An implementation is provided that will throw UnsupportedOperationException. A Faces implementation compliant with version 2.0 and beyond of the specification must override this method. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + java.util.List + + + + + + JSF:JAVADOC:5878 + Assuming the component metadata for argument topLevelComponent has been made available by an earlier call to ViewDeclarationLanguage#getComponentMetadata, leverage the component metadata for the purpose of re-targeting any method expressions from the top level component to the appropriate inner component. For each attribute that is a MethodExpression (as indicated by the presence of a "method-signature" attribute and the absence of a "type" attribute), the following action must be taken: Get the value of the targets attribute. If the value is a ValueExpression evaluate it. If there is no targets attribute, let the name of the metadata element be the evaluated value of the targets attribute. Interpret targets as a space (not tab) separated list of ids. For each entry in the list: Find the inner component of the topLevelComponent with the id equal to the current list entry. For discussion, this component is called target. If not found, log and error and continue to the next attribute. For discussion the declared name of the attribute is called name. In the attributes map of the topLevelComponent, look up the entry under the key name. Assume the result is a ValueExpression. For discussion, this is attributeValueExpression. If not found, log an error and continue to the next attribute. If name is equal to the string "action", or "actionListener" without the quotes, assume target is an jakarta.faces.component.ActionSource2. If name is equal to the string "validator", or "valueChangeListener" without the quotes, assume target is an jakarta.faces.component.EditableValueHolder. Call getExpressionString() on the attributeValueExpression and use that string to create a MethodExpression of the appropriate signature for name. If name is not equal to any of the previously listed strings, call getExpressionString() on the attributeValueExpression and use that string to create a MethodExpression where the signature is created based on the value of the "method-signature" attribute of the tag. Let the resultant MethodExpression be called attributeMethodExpression for discussion. If name is equal to the string "action" without the quotes, call jakarta.faces.component.ActionSource2#setActionExpression on target, passing attributeMethodExpression. If name is equal to the string "actionListener" without the quotes, call jakarta.faces.component.ActionSource#addActionListener on target, passing attributeMethodExpression wrapped in a jakarta.faces.event.MethodExpressionActionListener. If name is equal to the string "validator" without the quotes, call jakarta.faces.component.EditableValueHolder#addValidator on target, passing attributeMethodExpression wrapped in a jakarta.faces.validator.MethodExpressionValidator. If name is equal to the string "valueChangeListener" without the quotes, call jakarta.faces.component.EditableValueHolder#addValueChangeListener on target, passing attributeMethodExpression wrapped in a jakarta.faces.event.MethodExpressionValueChangeListener. Otherwise, assume that the MethodExpression should be placed in the components attribute set. The runtme must create the MethodExpression instance based on the value of the "method-signature" attribute. An implementation is provided that will throw UnsupportedOperationException. A Faces implementation compliant with version 2.0 and beyond of the specification must override this method. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5879 + + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + + + JSF:JAVADOC:5880 + If this view declaration language has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.view.ViewDeclarationLanguage + + + + + + JSF:JAVADOC:5881 + Tests whether a physical resource corresponding to the specified viewId exists. The default implementation uses jakarta.faces.application.ResourceHandler#createViewResource to locate the physical resource. + jakarta.faces.view + ViewDeclarationLanguageWrapper + + + jakarta.faces.context.FacesContext + java.lang.String + + + + + + JSF:JAVADOC:5882 + Creates a new UIViewRoot containing only view parameter metadata. The processing of building this UIViewRoot with metadata should not cause any events to be published to the application. The implementation must call FacesContext#setProcessingEvents passing false as the argument, at the beginning of the method, and pass true to the same method at the end. The implementation must ensure that this happens regardless of ant exceptions that may be thrown. Take note a compliant implementation has to ensure that: the new UIViewRoot must be set as the FacesContext's viewRoot before applying the tag handlers, restoring the old FacesContext in a finally block. The contents of the current UIViewRoot's ViewMap must be copied to the ViewMap of the new UIViewRoot before applying the tag handlers. The UIImportConstants must be processed after applying the tag handlers. + jakarta.faces.view + ViewMetadata + + + jakarta.faces.context.FacesContext + + + + + + JSF:JAVADOC:5883 + Utility method to extract view metadata from the provided UIViewRoot. + jakarta.faces.view + ViewMetadata + + + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:5884 + Utility method to extract view metadata from the provided UIViewRoot. + jakarta.faces.view + ViewMetadata + + + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:5885 + Get the view id + jakarta.faces.view + ViewMetadata + + + + + JSF:JAVADOC:5886 + Utility method to extract view metadata from the provided UIViewRoot. + jakarta.faces.view + ViewMetadata + + + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:5887 + Utility method to determine if the the provided UIViewRoot has metadata. The default implementation will return true if the provided UIViewRoot has a facet named UIViewRoot#METADATA_FACET_NAME and that facet has children. It will return false otherwise. + jakarta.faces.view + ViewMetadata + + + jakarta.faces.component.UIViewRoot + + + + + + JSF:JAVADOC:5888 + + jakarta.faces.view + ViewMetadata + + + + + JSF:JAVADOC:5889 + Returns the resolved literal String value of the attribute name after evaluating EL. + jakarta.faces.view.facelets + AttributeHandler + + + jakarta.faces.view.facelets.FaceletContext + + + + + + JSF:JAVADOC:5890 + Return the value of the behavior-id. + jakarta.faces.view.facelets + BehaviorConfig + + + + + JSF:JAVADOC:5891 + Constructs the handler using the Id from the config. + jakarta.faces.view.facelets + BehaviorHandler + + + jakarta.faces.view.facelets.BehaviorConfig + + + + + + JSF:JAVADOC:5892 + Returns the behavior Id obtained from the passed-in config. + jakarta.faces.view.facelets + BehaviorHandler + + + + + JSF:JAVADOC:5893 + Returns the event that is set as the "event" attribute on the behavior tag. + jakarta.faces.view.facelets + BehaviorHandler + + + + + JSF:JAVADOC:5894 + Return the client event name to which this behavior applies. + jakarta.faces.view.facelets + BehaviorHandler + + + + + JSF:JAVADOC:5895 + ComponentType to pass to the Application. Cannot be null. + jakarta.faces.view.facelets + ComponentConfig + + + + + JSF:JAVADOC:5896 + RendererType to set on created UIComponent instances. + jakarta.faces.view.facelets + ComponentConfig + + + + + JSF:JAVADOC:5897 + Leverage the TagHandlerDelegateFactory provided by the implementation to create an instance of TagHandlerDelegate designed for use with ComponentHandler. + jakarta.faces.view.facelets + ComponentHandler + + + jakarta.faces.view.facelets.ComponentConfig + + + + + + JSF:JAVADOC:5898 + Subclasses that wish to take over the task of instantiating the UIComponent instance corresponding to this tag handler my override this method to do so. A null return from this method will cause the TagHandlerDelegate for instance to create the component instead. + jakarta.faces.view.facelets + ComponentHandler + + + jakarta.faces.view.facelets.FaceletContext + + + + + + JSF:JAVADOC:5899 + Returns the component configuration, a component-type/renderer-type pair. + jakarta.faces.view.facelets + ComponentHandler + + + + + JSF:JAVADOC:5900 + Determine if the passed component is not null and if it's new to the tree. This operation can be used for determining if attributes should be wired to the component. + jakarta.faces.view.facelets + ComponentHandler + + + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5901 + This method is guaranteed to be called after the component has been created but before it has been populated with children. + jakarta.faces.view.facelets + ComponentHandler + + + jakarta.faces.view.facelets.FaceletContext + jakarta.faces.component.UIComponent + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5902 + This method is guaranteed to be called after the component has been populated with children. + jakarta.faces.view.facelets + ComponentHandler + + + jakarta.faces.view.facelets.FaceletContext + jakarta.faces.component.UIComponent + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5903 + Calls apply on any child handlers. + jakarta.faces.view.facelets + CompositeFaceletHandler + + + jakarta.faces.view.facelets.FaceletContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5904 + + jakarta.faces.view.facelets + CompositeFaceletHandler + + + jakarta.faces.view.facelets.FaceletContext + jakarta.faces.component.UIComponent + + java.io.IOException + + + + + JSF:JAVADOC:5905 + Creates a new FaceletHandler out of the given inner FaceletHandlers. + jakarta.faces.view.facelets + CompositeFaceletHandler + + + jakarta.faces.view.facelets.FaceletHandler[] + + + + + + JSF:JAVADOC:5906 + Returns the array of child handlers contained by this handler. + jakarta.faces.view.facelets + CompositeFaceletHandler + + + + + JSF:JAVADOC:5907 + Return the converter id to be used in instantiating this converter + jakarta.faces.view.facelets + ConverterConfig + + + + + JSF:JAVADOC:5908 + Creates a new ConverterHandler using the given config. + jakarta.faces.view.facelets + ConverterHandler + + + jakarta.faces.view.facelets.ConverterConfig + + + + + + JSF:JAVADOC:5909 + Returns the converter Id. The converter Id is taken from the attribute "converterId" + jakarta.faces.view.facelets + ConverterHandler + + + jakarta.faces.view.facelets.FaceletContext + + + + + + JSF:JAVADOC:5910 + The default implementation simply calls through to TagHandlerDelegate#apply. + jakarta.faces.view.facelets + DelegatingMetaTagHandler + + + jakarta.faces.view.facelets.FaceletContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5911 + + jakarta.faces.view.facelets + DelegatingMetaTagHandler + + + jakarta.faces.view.facelets.FaceletContext + jakarta.faces.component.UIComponent + + java.io.IOException + + + + + JSF:JAVADOC:5912 + Invoke the apply() method on this instance's TagHandler#nextHandler. + jakarta.faces.view.facelets + DelegatingMetaTagHandler + + + jakarta.faces.view.facelets.FaceletContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5913 + if thrown by the next FaceletHandler + jakarta.faces.view.facelets + DelegatingMetaTagHandler + + + jakarta.faces.view.facelets.FaceletContext + jakarta.faces.component.UIComponent + + java.io.IOException + + + + + JSF:JAVADOC:5914 + if thrown by the next FaceletHandler + jakarta.faces.view.facelets + DelegatingMetaTagHandler + + + jakarta.faces.view.facelets.FaceletContext + jakarta.faces.component.UIComponent + + jakarta.faces.FacesException + + + + + JSF:JAVADOC:5915 + if thrown by the next FaceletHandler + jakarta.faces.view.facelets + DelegatingMetaTagHandler + + + jakarta.faces.view.facelets.FaceletContext + jakarta.faces.component.UIComponent + + jakarta.el.ELException + + + + + JSF:JAVADOC:5916 + Instantiates this handler with the given config. + jakarta.faces.view.facelets + DelegatingMetaTagHandler + + + jakarta.faces.view.facelets.TagConfig + + + + + + JSF:JAVADOC:5917 + Return the "binding" attribute. + jakarta.faces.view.facelets + DelegatingMetaTagHandler + + + + + JSF:JAVADOC:5918 + Return a reference to the Tag instance corresponding to this TagHandler instance. + jakarta.faces.view.facelets + DelegatingMetaTagHandler + + + + + JSF:JAVADOC:5919 + Return the named attribute from the tag attributes. + jakarta.faces.view.facelets + DelegatingMetaTagHandler + + + java.lang.String + + + + + + JSF:JAVADOC:5920 + Return the tag id from the TagConfig used to instantiate this handler. + jakarta.faces.view.facelets + DelegatingMetaTagHandler + + + + + JSF:JAVADOC:5921 + Returns the value of the "disabled" attribute. + jakarta.faces.view.facelets + DelegatingMetaTagHandler + + + jakarta.faces.view.facelets.FaceletContext + + + + + + JSF:JAVADOC:5922 + Invoking/extending this method will cause the results of the created MetaRuleset to auto-wire state to the passed instance. + jakarta.faces.view.facelets + DelegatingMetaTagHandler + + + jakarta.faces.view.facelets.FaceletContext + java.lang.Object + + + + + + JSF:JAVADOC:5923 + The passed UIComponent parent will be populated/restored in accordance with the section 10.2.1 "Specification of the ViewDeclarationLanguage Implementation for Facelets for Jakarta Faces" in the Jakarta Faces Specification Document. + jakarta.faces.view.facelets + Facelet + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5924 + if unable to load a file necessary to apply this Facelet + jakarta.faces.view.facelets + Facelet + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.io.IOException + + + + + JSF:JAVADOC:5925 + The passed UIComponent parent will be populated/restored in accordance with the section 10.2.1 "Specification of the ViewDeclarationLanguage Implementation for Facelets for Jakarta Faces" in the Jakarta Faces Specification Document with only the meta data as per the f:metadata tag. + jakarta.faces.view.facelets + Facelet + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5926 + if unable to load a file necessary to apply this Facelet + jakarta.faces.view.facelets + Facelet + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + java.io.IOException + + + + + JSF:JAVADOC:5927 + + jakarta.faces.view.facelets + Facelet + + + + + JSF:JAVADOC:5928 + + jakarta.faces.view.facelets + FaceletCache + + + + + JSF:JAVADOC:5929 + Returns a cached Facelet instance. If no instance is available, it will be created using the Facelet MemberFactory and stored in the cache. + jakarta.faces.view.facelets + FaceletCache + + + java.net.URL + + + + + + JSF:JAVADOC:5930 + if unable to load a file necessary to respond to service this method. + jakarta.faces.view.facelets + FaceletCache + + + java.net.URL + + java.io.IOException + + + + + JSF:JAVADOC:5931 + Returns a cached View Metadata Facelet instance. If no instance is available, it will be created using the View Metadata Facelet MemberFactory and stored in the cache. + jakarta.faces.view.facelets + FaceletCache + + + java.net.URL + + + + + + JSF:JAVADOC:5932 + if unable to load a file necessary to respond to service this method. + jakarta.faces.view.facelets + FaceletCache + + + java.net.URL + + java.io.IOException + + + + + JSF:JAVADOC:5933 + Determines whether a cached Facelet instance exists for this URL. Returns true if a cached instance exists, false otherwise + jakarta.faces.view.facelets + FaceletCache + + + java.net.URL + + + + + + JSF:JAVADOC:5934 + Determines whether a cached View Metadata Facelet instance exists for this URL. Returns true if a cached instance exists, false otherwise + jakarta.faces.view.facelets + FaceletCache + + + java.net.URL + + + + + + JSF:JAVADOC:5935 + This must be called by the runtime at startup time, before any requests are serviced, and allows for the FaceletCache implementation to provide the MemberFactory instances that will be used to create instances of Facelets and View Metadata Facelets. + jakarta.faces.view.facelets + FaceletCache + + + jakarta.faces.view.facelets.FaceletCache.FaceletCache.MemberFactory + jakarta.faces.view.facelets.FaceletCache.FaceletCache.MemberFactory + + + + + + JSF:JAVADOC:5936 + Create a Facelet or View Metadata Facelet (depending on the type of factory this is) for the argument URL. + jakarta.faces.view.facelets + FaceletCache.MemberFactory + + + java.net.URL + + + + + + JSF:JAVADOC:5937 + if unable to load a file necessary to respond to service this method. + jakarta.faces.view.facelets + FaceletCache.MemberFactory + + + java.net.URL + + java.io.IOException + + + + + JSF:JAVADOC:5938 + + jakarta.faces.view.facelets + FaceletCacheFactory + + + + + JSF:JAVADOC:5939 + If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.view.facelets + FaceletCacheFactory + + + jakarta.faces.view.facelets.FaceletCacheFactory + + + + + + JSF:JAVADOC:5940 + Returns the facility by which the Facelets jakarta.faces.view.ViewDeclarationLanguage creates and caches instances of Facelets. + jakarta.faces.view.facelets + FaceletCacheFactory + + + + + JSF:JAVADOC:5941 + If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped. + jakarta.faces.view.facelets + FaceletCacheFactory + + + + + JSF:JAVADOC:5942 + + jakarta.faces.view.facelets + FaceletContext + + + + + JSF:JAVADOC:5943 + Generate a unique ID for the passed String + jakarta.faces.view.facelets + FaceletContext + + + java.lang.String + + + + + + JSF:JAVADOC:5944 + Return an attribute set by a previous call to #setAttribute. Support method which is backed by the current VariableMapper + jakarta.faces.view.facelets + FaceletContext + + + java.lang.String + + + + + + JSF:JAVADOC:5945 + The ExpressionFactory to use within the Facelet this context is executing upon. Must not be null. + jakarta.faces.view.facelets + FaceletContext + + + + + JSF:JAVADOC:5946 + The current FacesContext bound to this "request". Must not be null. + jakarta.faces.view.facelets + FaceletContext + + + + + JSF:JAVADOC:5947 + Include another Facelet defined at some path, relative to the executing context, not the current Facelet (same as include directive in Jakarta Server Pages) + jakarta.faces.view.facelets + FaceletContext + + + jakarta.faces.component.UIComponent + java.lang.String + + + + + + JSF:JAVADOC:5948 + if unable to load relativePath + jakarta.faces.view.facelets + FaceletContext + + + jakarta.faces.component.UIComponent + java.lang.String + + java.io.IOException + + + + + JSF:JAVADOC:5949 + Include another Facelet defined at some path, absolute to this ClassLoader/OS + jakarta.faces.view.facelets + FaceletContext + + + jakarta.faces.component.UIComponent + java.net.URL + + + + + + JSF:JAVADOC:5950 + if unable to load relativePath + jakarta.faces.view.facelets + FaceletContext + + + jakarta.faces.component.UIComponent + java.net.URL + + java.io.IOException + + + + + JSF:JAVADOC:5951 + Support method which is backed by the current VariableMapper. + jakarta.faces.view.facelets + FaceletContext + + + java.lang.String + java.lang.Object + + + + + + JSF:JAVADOC:5952 + Set the FunctionMapper to use in EL evaluation/creation. + jakarta.faces.view.facelets + FaceletContext + + + jakarta.el.FunctionMapper + + + + + + JSF:JAVADOC:5953 + Set the VariableMapper to use in EL evaluation/creation. + jakarta.faces.view.facelets + FaceletContext + + + jakarta.el.VariableMapper + + + + + + JSF:JAVADOC:5954 + Create an empty FaceletException. + jakarta.faces.view.facelets + FaceletException + + + + + JSF:JAVADOC:5955 + Create a FaceletException with argument message as the message. + jakarta.faces.view.facelets + FaceletException + + + java.lang.String + + + + + + JSF:JAVADOC:5956 + Wrap argument cause within this FaceletException instance. + jakarta.faces.view.facelets + FaceletException + + + java.lang.Throwable + + + + + + JSF:JAVADOC:5957 + Wrap argument cause in a FaceletException instance, with a message given by the argument message. + jakarta.faces.view.facelets + FaceletException + + + java.lang.String + java.lang.Throwable + + + + + + JSF:JAVADOC:5958 + Process changes on a particular UIComponent + jakarta.faces.view.facelets + FaceletHandler + + + jakarta.faces.view.facelets.FaceletContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5959 + if unable to load relativePath + jakarta.faces.view.facelets + FaceletHandler + + + jakarta.faces.view.facelets.FaceletContext + jakarta.faces.component.UIComponent + + java.io.IOException + + + + + JSF:JAVADOC:5960 + Take the necessary actions to apply the attached object represented by the tag for the concrete subclass of this class to the argument parent. + jakarta.faces.view.facelets + FaceletsAttachedObjectHandler + + + jakarta.faces.context.FacesContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:5961 + Call through to super + jakarta.faces.view.facelets + FaceletsAttachedObjectHandler + + + jakarta.faces.view.facelets.TagConfig + + + + + + JSF:JAVADOC:5962 + Return the value of the "for" attribute. This enables the runtime to know to which inner component this attached object should be retargeted. + jakarta.faces.view.facelets + FaceletsAttachedObjectHandler + + + + + JSF:JAVADOC:5963 + Returns the resolved literal String value of the facet name after evaluating EL. + jakarta.faces.view.facelets + FacetHandler + + + jakarta.faces.view.facelets.FaceletContext + + + + + + JSF:JAVADOC:5964 + Take the action prescribed in the Jakarta Faces Specification for this particular VDL element attribute. + jakarta.faces.view.facelets + Metadata + + + jakarta.faces.view.facelets.FaceletContext + java.lang.Object + + + + + + JSF:JAVADOC:5965 + + jakarta.faces.view.facelets + Metadata + + + + + JSF:JAVADOC:5966 + Return a beans PropertyDescriptor for the property with name given by argument name. + jakarta.faces.view.facelets + MetadataTarget + + + java.lang.String + + + + + + JSF:JAVADOC:5967 + Return a Class for the property with name given by argument name. + jakarta.faces.view.facelets + MetadataTarget + + + java.lang.String + + + + + + JSF:JAVADOC:5968 + Return a Method for the getter of the property with name given by argument name. + jakarta.faces.view.facelets + MetadataTarget + + + java.lang.String + + + + + + JSF:JAVADOC:5969 + Return the Class of the metadata target. + jakarta.faces.view.facelets + MetadataTarget + + + + + JSF:JAVADOC:5970 + Return a Method for the setter of the property with name given by argument name. + jakarta.faces.view.facelets + MetadataTarget + + + java.lang.String + + + + + + JSF:JAVADOC:5971 + Return true if the target for this metadata element is an instance of the argument type. + jakarta.faces.view.facelets + MetadataTarget + + + java.lang.Class + + + + + + JSF:JAVADOC:5972 + + jakarta.faces.view.facelets + MetadataTarget + + + + + JSF:JAVADOC:5973 + Return an abstraction that takes appropriate action given the kind of rule represented by the argument name, in the context of this particular concrete subclass of MetaRule. The abstraction must encapsulate the value from the argument attribute. + jakarta.faces.view.facelets + MetaRule + + + java.lang.String + jakarta.faces.view.facelets.TagAttribute + jakarta.faces.view.facelets.MetadataTarget + + + + + + JSF:JAVADOC:5974 + + jakarta.faces.view.facelets + MetaRule + + + + + JSF:JAVADOC:5975 + Add another Metadata to this ruleset, returning this. + jakarta.faces.view.facelets + MetaRuleset + + + jakarta.faces.view.facelets.Metadata + + + + + + JSF:JAVADOC:5976 + Add another MetaRule to this ruleset, returning this. + jakarta.faces.view.facelets + MetaRuleset + + + jakarta.faces.view.facelets.MetaRule + + + + + + JSF:JAVADOC:5977 + Customize this MetaRuleset by removing the attribute named by argument attribute and re-adding it under the name given by the argument property, returning this. + jakarta.faces.view.facelets + MetaRuleset + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:5978 + Take actions to apply the rule. + jakarta.faces.view.facelets + MetaRuleset + + + + + JSF:JAVADOC:5979 + Customize this MetaRuleset instance to advise it to ignore the attribute named by the attribute argument, returning this. + jakarta.faces.view.facelets + MetaRuleset + + + java.lang.String + + + + + + JSF:JAVADOC:5980 + Customize this MetaRuleset instance to advise it to ignore all attributes, returning this. + jakarta.faces.view.facelets + MetaRuleset + + + + + JSF:JAVADOC:5981 + + jakarta.faces.view.facelets + MetaRuleset + + + + + JSF:JAVADOC:5982 + Constructor. + jakarta.faces.view.facelets + MetaTagHandler + + + jakarta.faces.view.facelets.TagConfig + + + + + + JSF:JAVADOC:5983 + Return an object encapsulating the TagAttributes specified on this element in the view. + jakarta.faces.view.facelets + Tag + + + + + JSF:JAVADOC:5984 + Return the XML local name of the tag. For example, would be "tag". + jakarta.faces.view.facelets + Tag + + + + + JSF:JAVADOC:5985 + Return the Location of this Tag instance in the Facelet view. + jakarta.faces.view.facelets + Tag + + + + + JSF:JAVADOC:5986 + Return the resolved XML Namespace for this tag in the Facelets view. + jakarta.faces.view.facelets + Tag + + + + + JSF:JAVADOC:5987 + Return the XML qualified name for this tag. For example, would be "my:tag". + jakarta.faces.view.facelets + Tag + + + + + JSF:JAVADOC:5988 + Constructor. + jakarta.faces.view.facelets + Tag + + + jakarta.faces.view.Location + java.lang.String + java.lang.String + java.lang.String + jakarta.faces.view.facelets.TagAttributes + + + + + + JSF:JAVADOC:5989 + Constructor. + jakarta.faces.view.facelets + Tag + + + jakarta.faces.view.facelets.Tag + jakarta.faces.view.facelets.TagAttributes + + + + + + JSF:JAVADOC:5990 + Get the string representation. + jakarta.faces.view.facelets + Tag + + + + + JSF:JAVADOC:5991 + If literal,return Boolean#valueOf(java.lang.String) Boolean.valueOf(java.lang.String) passing our value, otherwise call #getObject(FaceletContext, Class) getObject(FaceletContext, Class). + jakarta.faces.view.facelets + TagAttribute + + + jakarta.faces.view.facelets.FaceletContext + + + + + + JSF:JAVADOC:5992 + If literal, call Integer#parseInt(java.lang.String) Integer.parseInt(String), otherwise call #getObject(FaceletContext, Class) getObject(FaceletContext, Class). + jakarta.faces.view.facelets + TagAttribute + + + jakarta.faces.view.facelets.FaceletContext + + + + + + JSF:JAVADOC:5993 + Local name of this attribute + jakarta.faces.view.facelets + TagAttribute + + + + + JSF:JAVADOC:5994 + The location of this attribute in the FaceletContext + jakarta.faces.view.facelets + TagAttribute + + + + + JSF:JAVADOC:5995 + Create a MethodExpression, using this attribute's value as the expression String. + jakarta.faces.view.facelets + TagAttribute + + + jakarta.faces.view.facelets.FaceletContext + java.lang.Class + java.lang.Class[] + + + + + + JSF:JAVADOC:5996 + The resolved Namespace for this attribute + jakarta.faces.view.facelets + TagAttribute + + + + + JSF:JAVADOC:5997 + Delegates to getObject with Object.class as a param + jakarta.faces.view.facelets + TagAttribute + + + jakarta.faces.view.facelets.FaceletContext + + + + + + JSF:JAVADOC:5998 + If literal, simply coerce our String literal value using an ExpressionFactory, otherwise create a ValueExpression and evaluate it. + jakarta.faces.view.facelets + TagAttribute + + + jakarta.faces.view.facelets.FaceletContext + java.lang.Class + + + + + + JSF:JAVADOC:5999 + The qualified name for this attribute + jakarta.faces.view.facelets + TagAttribute + + + + + JSF:JAVADOC:6000 + A reference to the Tag for which this class represents the attributes. For compatibility with previous implementations, an implementation is provided that returns null. + jakarta.faces.view.facelets + TagAttribute + + + + + JSF:JAVADOC:6001 + Return the literal value of this attribute + jakarta.faces.view.facelets + TagAttribute + + + + + JSF:JAVADOC:6002 + If literal, then return our value, otherwise delegate to getObject, passing String.class. + jakarta.faces.view.facelets + TagAttribute + + + jakarta.faces.view.facelets.FaceletContext + + + + + + JSF:JAVADOC:6003 + Create a ValueExpression, using this attribute's literal value and the passed expected type. + jakarta.faces.view.facelets + TagAttribute + + + jakarta.faces.view.facelets.FaceletContext + java.lang.Class + + + + + + JSF:JAVADOC:6004 + If this TagAttribute is literal (not #{..} or ${..}) + jakarta.faces.view.facelets + TagAttribute + + + + + JSF:JAVADOC:6005 + Set a reference to the Tag for which this class represents the attributes. The VDL runtime must ensure that this method is called before any FaceletHandlers for this element are instantiated. For compatibility with previous implementations, a no-op implementation is provided. + jakarta.faces.view.facelets + TagAttribute + + + jakarta.faces.view.facelets.Tag + + + + + + JSF:JAVADOC:6006 + + jakarta.faces.view.facelets + TagAttribute + + + + + JSF:JAVADOC:6007 + Constructor. + jakarta.faces.view.facelets + TagAttributeException + + + jakarta.faces.view.facelets.TagAttribute + + + + + + JSF:JAVADOC:6008 + Constructor. + jakarta.faces.view.facelets + TagAttributeException + + + jakarta.faces.view.facelets.TagAttribute + java.lang.String + + + + + + JSF:JAVADOC:6009 + Constructor. + jakarta.faces.view.facelets + TagAttributeException + + + jakarta.faces.view.facelets.TagAttribute + java.lang.Throwable + + + + + + JSF:JAVADOC:6010 + Constructor. + jakarta.faces.view.facelets + TagAttributeException + + + jakarta.faces.view.facelets.TagAttribute + java.lang.String + java.lang.Throwable + + + + + + JSF:JAVADOC:6011 + Constructor. + jakarta.faces.view.facelets + TagAttributeException + + + jakarta.faces.view.facelets.Tag + jakarta.faces.view.facelets.TagAttribute + + + + + + JSF:JAVADOC:6012 + Constructor. + jakarta.faces.view.facelets + TagAttributeException + + + jakarta.faces.view.facelets.Tag + jakarta.faces.view.facelets.TagAttribute + java.lang.String + + + + + + JSF:JAVADOC:6013 + Constructor. + jakarta.faces.view.facelets + TagAttributeException + + + jakarta.faces.view.facelets.Tag + jakarta.faces.view.facelets.TagAttribute + java.lang.Throwable + + + + + + JSF:JAVADOC:6014 + Constructor. + jakarta.faces.view.facelets + TagAttributeException + + + jakarta.faces.view.facelets.Tag + jakarta.faces.view.facelets.TagAttribute + java.lang.String + java.lang.Throwable + + + + + + JSF:JAVADOC:6015 + Using no namespace, find the TagAttribute + jakarta.faces.view.facelets + TagAttributes + + + java.lang.String + + + + + + JSF:JAVADOC:6016 + Find a TagAttribute that matches the passed namespace and local name. + jakarta.faces.view.facelets + TagAttributes + + + java.lang.String + java.lang.String + + + + + + JSF:JAVADOC:6017 + Return an array of all TagAttributes in this set + jakarta.faces.view.facelets + TagAttributes + + + + + JSF:JAVADOC:6018 + Get all TagAttributes for the passed namespace + jakarta.faces.view.facelets + TagAttributes + + + java.lang.String + + + + + + JSF:JAVADOC:6019 + A list of Namespaces found in this set + jakarta.faces.view.facelets + TagAttributes + + + + + JSF:JAVADOC:6020 + A reference to the Tag for which this class represents the attributes. For compatibility with previous implementations, an implementation is provided that returns null. + jakarta.faces.view.facelets + TagAttributes + + + + + JSF:JAVADOC:6021 + Set a reference to the Tag for which this class represents the attributes. The VDL runtime must ensure that this method is called before any FaceletHandlers for this element are instantiated. For compatibility with previous implementations, a no-op implementation is provided. + jakarta.faces.view.facelets + TagAttributes + + + jakarta.faces.view.facelets.Tag + + + + + + JSF:JAVADOC:6022 + + jakarta.faces.view.facelets + TagAttributes + + + + + JSF:JAVADOC:6023 + The next FaceletHandler (child or children) to be applied. This must never be null. + jakarta.faces.view.facelets + TagConfig + + + + + JSF:JAVADOC:6024 + Return the Tag representing this handler. + jakarta.faces.view.facelets + TagConfig + + + + + JSF:JAVADOC:6025 + A document-unique id, follows the convention "_tagId##" + jakarta.faces.view.facelets + TagConfig + + + + + JSF:JAVADOC:6026 + If handled, return a new Tag instance, otherwise return null + jakarta.faces.view.facelets + TagDecorator + + + jakarta.faces.view.facelets.Tag + + + + + + JSF:JAVADOC:6027 + Wrap the argument tag so the exception can reference its information. + jakarta.faces.view.facelets + TagException + + + jakarta.faces.view.facelets.Tag + + + + + + JSF:JAVADOC:6028 + Wrap the argument tag so the exception can reference its information. + jakarta.faces.view.facelets + TagException + + + jakarta.faces.view.facelets.Tag + java.lang.String + + + + + + JSF:JAVADOC:6029 + Wrap the argument tag so the exception can reference its information. + jakarta.faces.view.facelets + TagException + + + jakarta.faces.view.facelets.Tag + java.lang.Throwable + + + + + + JSF:JAVADOC:6030 + Wrap the argument tag so the exception can reference its information. + jakarta.faces.view.facelets + TagException + + + jakarta.faces.view.facelets.Tag + java.lang.String + java.lang.Throwable + + + + + + JSF:JAVADOC:6031 + Every TagHandler instance is associated with a Tag. Each Tag instance has a TagAttributes property, which is simply a collection of TagAttribute instances. Extract and save as protected instance variables the TagConfig#getTagId, TagConfig#getTag and TagConfig#getNextHandler returns from the argument TagConfig. This constructor is only called when the Facelets View is compiled. + jakarta.faces.view.facelets + TagHandler + + + jakarta.faces.view.facelets.TagConfig + + + + + + JSF:JAVADOC:6032 + + jakarta.faces.view.facelets + TagHandler + + + + + JSF:JAVADOC:6033 + Called by classes that implement jakarta.faces.view.facelets.FaceletHandler in their implementation of apply(). If the argument comp is new to the view, for each tag attribute declared to be in the pass through attribute namespace, set the name and value of the attribute into the pass through attributes map of the component. See UIComponent#getPassThroughAttributes(boolean) . See the VDLDocs for the namespace URI of the pass through attribute namespace. Attributes whose value is a ValueExpression must remain un-evaluated and stored in the map as ValueExpression instances. + jakarta.faces.view.facelets + TagHandlerDelegate + + + jakarta.faces.view.facelets.FaceletContext + jakarta.faces.component.UIComponent + + + + + + JSF:JAVADOC:6034 + if any files necessary to apply this tag handler have any difficulty while loading + jakarta.faces.view.facelets + TagHandlerDelegate + + + jakarta.faces.view.facelets.FaceletContext + jakarta.faces.component.UIComponent + + java.io.IOException + + + + + JSF:JAVADOC:6035 + Return a MetaRuleset particular to this kind of tag handler. Called from classes that implement MetaTagHandler. + jakarta.faces.view.facelets + TagHandlerDelegate + + + java.lang.Class + + + + + + JSF:JAVADOC:6036 + + jakarta.faces.view.facelets + TagHandlerDelegate + + + + + JSF:JAVADOC:6037 + Create and return a TagHandlerDelegate instance designed for use with BehaviorHandler. + jakarta.faces.view.facelets + TagHandlerDelegateFactory + + + jakarta.faces.view.facelets.BehaviorHandler + + + + + + JSF:JAVADOC:6038 + Create and return a TagHandlerDelegate instance designed for use with ComponentHandler. + jakarta.faces.view.facelets + TagHandlerDelegateFactory + + + jakarta.faces.view.facelets.ComponentHandler + + + + + + JSF:JAVADOC:6039 + Create and return a TagHandlerDelegate instance designed for use with ConverterHandler. + jakarta.faces.view.facelets + TagHandlerDelegateFactory + + + jakarta.faces.view.facelets.ConverterHandler + + + + + + JSF:JAVADOC:6040 + Create and return a TagHandlerDelegate instance designed for use with ValidatorHandler. + jakarta.faces.view.facelets + TagHandlerDelegateFactory + + + jakarta.faces.view.facelets.ValidatorHandler + + + + + + JSF:JAVADOC:6041 + If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped. + jakarta.faces.view.facelets + TagHandlerDelegateFactory + + + + + JSF:JAVADOC:6042 + + jakarta.faces.view.facelets + TagHandlerDelegateFactory + + + + + JSF:JAVADOC:6043 + If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The #getWrapped() will then return the implementation being wrapped. + jakarta.faces.view.facelets + TagHandlerDelegateFactory + + + jakarta.faces.view.facelets.TagHandlerDelegateFactory + + + + + + JSF:JAVADOC:6044 + Returns the literal String value of the contained text. + jakarta.faces.view.facelets + TextHandler + + + + + JSF:JAVADOC:6045 + Returns the resolved literal String value of the contained text after evaluating EL. + jakarta.faces.view.facelets + TextHandler + + + jakarta.faces.view.facelets.FaceletContext + + + + + + JSF:JAVADOC:6046 + Return the validator-id associated with a particular validator in your faces-config + jakarta.faces.view.facelets + ValidatorConfig + + + + + JSF:JAVADOC:6047 + Return the TagConfig subclass used to configure this handler instance. + jakarta.faces.view.facelets + ValidatorHandler + + + + + JSF:JAVADOC:6048 + Retrieve the id of the validator that is to be created and added to the parent EditableValueHolder. All subclasses should override this method because it is important for Facelets to have a unique way of identifying the validators that are added to this EditableValueHolder and allows exclusions to work properly. An exclusion is a validator declaration that has the attribute "disabled" which resolves to false, instructing Facelets not to register a default validator with the same id. + jakarta.faces.view.facelets + ValidatorHandler + + + jakarta.faces.view.facelets.FaceletContext + + + + + + JSF:JAVADOC:6049 + Construct this instance around the configuration information in argument config + jakarta.faces.view.facelets + ValidatorHandler + + + jakarta.faces.view.facelets.ValidatorConfig + + + + + + JSF:JAVADOC:6050 + Return the ServletConfig instance for this servlet. + jakarta.faces.webapp + FacesServlet + + + + + JSF:JAVADOC:6051 + Acquire the factory instances we will require. + jakarta.faces.webapp + FacesServlet + + + jakarta.servlet.ServletConfig + + + + + + JSF:JAVADOC:6052 + if, for any reason, the startup of this Faces application failed. This includes errors in the config file that is parsed before or during the processing of this init() method. + jakarta.faces.webapp + FacesServlet + + + jakarta.servlet.ServletConfig + + jakarta.servlet.ServletException + + + + + JSF:JAVADOC:6053 + Process an incoming request, and create the corresponding response according to the following specification. If the request and response arguments to this method are not instances of HttpServletRequest and HttpServletResponse, respectively, the results of invoking this method are undefined. This method must respond to requests that contain the following strings by invoking the sendError method on the response argument (cast to HttpServletResponse), passing the code HttpServletResponse.SC_NOT_FOUND as the argument. /WEB-INF/ /WEB-INF /META-INF/ /META-INF If none of the cases described above in the specification for this method apply to the servicing of this request, the following action must be taken to service the request. Acquire a FacesContext instance for this request. Acquire the ResourceHandler for this request by calling jakarta.faces.application.Application#getResourceHandler. Call jakarta.faces.application.ResourceHandler#isResourceRequest. If this returns true call jakarta.faces.application.ResourceHandler#handleResourceRequest. If this returns false, call jakarta.faces.lifecycle.Lifecycle#attachWindow followed by jakarta.faces.lifecycle.Lifecycle#execute followed by jakarta.faces.lifecycle.Lifecycle#render. If a jakarta.faces.FacesException is thrown in either case, extract the cause from the FacesException. If the cause is null extract the message from the FacesException, put it inside of a new ServletException instance, and pass the FacesException instance as the root cause, then rethrow the ServletException instance. If the cause is an instance of ServletException, rethrow the cause. If the cause is an instance of IOException, rethrow the cause. Otherwise, create a new ServletException instance, passing the message from the cause, as the first argument, and the cause itself as the second argument. The implementation must make it so jakarta.faces.context.FacesContext#release is called within a finally block as late as possible in the processing for the Jakarta Faces related portion of this request. + jakarta.faces.webapp + FacesServlet + + + jakarta.servlet.ServletRequest + jakarta.servlet.ServletResponse + + + + + + JSF:JAVADOC:6054 + if an input/output error occurs during processing + jakarta.faces.webapp + FacesServlet + + + jakarta.servlet.ServletRequest + jakarta.servlet.ServletResponse + + java.io.IOException + + + + + JSF:JAVADOC:6055 + if a Jakarta Servlet error occurs during processing + jakarta.faces.webapp + FacesServlet + + + jakarta.servlet.ServletRequest + jakarta.servlet.ServletResponse + + jakarta.servlet.ServletException + + + + +