diff --git a/impl/pom.xml b/impl/pom.xml index 8d2e120136..faefc5830f 100644 --- a/impl/pom.xml +++ b/impl/pom.xml @@ -350,6 +350,7 @@ attach-javadocs com + true jar diff --git a/impl/src/main/java/com/sun/faces/spi/ServiceFactory.java b/impl/src/main/java/com/sun/faces/spi/ServiceFactoryUtils.java similarity index 100% rename from impl/src/main/java/com/sun/faces/spi/ServiceFactory.java rename to impl/src/main/java/com/sun/faces/spi/ServiceFactoryUtils.java diff --git a/impl/src/main/java/javax/faces/annotation/package-info.java b/impl/src/main/java/javax/faces/annotation/package-info.java new file mode 100644 index 0000000000..388da6ab0f --- /dev/null +++ b/impl/src/main/java/javax/faces/annotation/package-info.java @@ -0,0 +1,5 @@ +/** + *

Annotations in this class allow injection of JSF + * objects into CDI beans.

+ */ +package javax.faces.annotation; diff --git a/impl/src/main/java/javax/faces/application/package-info.java b/impl/src/main/java/javax/faces/application/package-info.java new file mode 100644 index 0000000000..d25776fd97 --- /dev/null +++ b/impl/src/main/java/javax/faces/application/package-info.java @@ -0,0 +1,11 @@ +/** + *

+ * APIs + * that are used to link an application's business logic objects to JavaServer + * Faces, as well as convenient pluggable mechanisms to manage the execution of + * an application that is based on JavaServer Faces. The main class in this + * package is {@link + * javax.faces.application.Application}.

+ */ +package javax.faces.application; diff --git a/impl/src/main/java/javax/faces/component/behavior/package-info.java b/impl/src/main/java/javax/faces/component/behavior/package-info.java new file mode 100644 index 0000000000..940d98bd19 --- /dev/null +++ b/impl/src/main/java/javax/faces/component/behavior/package-info.java @@ -0,0 +1,7 @@ +/** + *

+ * APIs for + * attaching additional behavior to user interface components.

+ */ +package javax.faces.component.behavior; diff --git a/impl/src/main/java/javax/faces/component/html/package-info.java b/impl/src/main/java/javax/faces/component/html/package-info.java new file mode 100644 index 0000000000..73c7be3708 --- /dev/null +++ b/impl/src/main/java/javax/faces/component/html/package-info.java @@ -0,0 +1,6 @@ +/** + *

+ * Specialized user interface + * component classes for HTML.

+ */ +package javax.faces.component.html; diff --git a/impl/src/main/java/javax/faces/component/package-info.java b/impl/src/main/java/javax/faces/component/package-info.java new file mode 100644 index 0000000000..bf3ac8681e --- /dev/null +++ b/impl/src/main/java/javax/faces/component/package-info.java @@ -0,0 +1,12 @@ +/** + *

+ * Fundamental APIs for user + * interface components.

+ *

+ * For your convenience here is a UML class diagram of the classes in this + * package.

+ * UIComponent hierarchy + */ +package javax.faces.component; diff --git a/impl/src/main/java/javax/faces/component/search/package-info.java b/impl/src/main/java/javax/faces/component/search/package-info.java new file mode 100644 index 0000000000..6add43a360 --- /dev/null +++ b/impl/src/main/java/javax/faces/component/search/package-info.java @@ -0,0 +1,141 @@ +/** + *

APIs for searching for components in the + * component tree by using expressions.

+ *
+ *

+ * This feature has two entry points: for the page author and for the Java + * programmer. Following is a brief overview of each.

+ *

For the Page Author

+ *

+ * The following tags support the use of search expressions: + * <h:message />, <h:messages + * />, <h:outputLabel />, and + * <f:ajax />. Each of those tags have one or more attributes + * whose value must be a client identifier. This feature expands the capability + * of those attributes to be search expressions. A search expression is space + * separated list of tokens, where a token can either be a client identifier, a + * search keyword, or a combination of both. See the specification for + * {@link javax.faces.component.search.SearchKeywordResolver} + * for the list of keywords that must be supported. See the specification for + * {@link javax.faces.component.search.SearchExpressionHandler} + * to learn how the search is performed.

+ *

+ * Here is a brief example of the page author use case:

+ *
  1. <h:body>
    2. + *
  2.   <h:outputLabel + * id="label" for="@next" value="Test" + * />
    3. + *
  3.   <h:inputText + * id="input">
    4. + *
  4.     <f:ajax render="@this @next" />
    5. + *
  5.   </h:inputText>
    6. + *
  6.   <h:inputText id="input2" + * />
    7. + *
  7. </h:body>
+ *

For the Java Programmer

+ *

+ * Using search expressions from Java code offers more flexibility. One must + * obtain a handle to the + * {@link javax.faces.component.search.SearchExpressionHandler} + * and invoke methods on it as desired.

+ *

+ * The following example resolves to a clientId:

+ *
+ *
+ *
    + *
  1. SearchExpressionHandler handler = + * facesContext.getApplication().getSearchExpressionHandler();
    2. + *
  2. SearchExpressionContext context = + * SearchExpressionContext.createSearchExpressionContext(facesContext, + * facesContext.getViewRoot());
    3. + *
  3. String clientId = + * handler.resolveClientId(context, + * ":form:container:@next");
    4. + *
+ *
+ *
+ *

+ * The following example resolves to a component:

+ *
+ *
+ *
    + *
  1. SearchExpressionHandler handler = + * facesContext.getApplication().getSearchExpressionHandler();
    2. + *
  2. SearchExpressionContext context = + * SearchExpressionContext.createSearchExpressionContext(facesContext, + * facesContext.getViewRoot());
    3. + *
  3. handler.resolveComponent(context, + * ":form:container:@next",
    4. + *
  4.            + *     new + * ContextCallback() + * {
    5. + *
  5.             + *        public void + * invokeContextCallback(FacesContext context, + *
    6. + *
  6.             + *                       + *           UIComponent + * target) + * {
    7. + *
  7.             + *            // target == the + * resolved component
    8. + *
  8.             + *        }
    9. + *
  9.            + *     }); + *
+ *

+ * The following example uses multiple expressions and therefor resolves to + * multiple components:

+ *
+ *
+ *
    + *
  1. SearchExpressionHandler handler = + * facesContext.getApplication().getSearchExpressionHandler();
    2. + *
  2. SearchExpressionContext context = + * SearchExpressionContext.createSearchExpressionContext(facesContext, + * facesContext.getViewRoot());
    3. + *
  3. handler.resolveComponents(context, + * ":form:container:@next :input1 input2:@parent",
    4. + *
  4.            + *     new + * ContextCallback() + * {
    5. + *
  5.             + *        public void + * invokeContextCallback(FacesContext context, + *
    6. + *
  6.             + *                       + *           UIComponent + * target) + * {
    7. + *
  7.             + *            // target == the + * resolved component
    8. + *
  8.             + *        }
    9. + *
  9.            + *     }); + *
+ *
+ *

Extending the Capabilities of the Component Search Facility

+ *

+ * Creation of the + * {@link javax.faces.component.search.SearchExpressionContext}

+ *

+ * As with other factories in JSF, the FactoryFinder is used by the + * system to create instances of the SearchExpressionContext which + * holds state during the operation of this API.

+ *

+ * Adding new {@link javax.faces.component.search.SearchKewordResolver}s

+ *

+ * See + * {@link javax.faces.component.search.SearchKeywordResolver} + * for the specification of how the set of keywords can be expanded.

+ *
+ */ +package javax.faces.component.search; diff --git a/impl/src/main/java/javax/faces/component/visit/package-info.java b/impl/src/main/java/javax/faces/component/visit/package-info.java new file mode 100644 index 0000000000..f0218401de --- /dev/null +++ b/impl/src/main/java/javax/faces/component/visit/package-info.java @@ -0,0 +1,80 @@ +/** + *

APIs + * for traversing a user interface component view.

+ * +
+ * +

+ * The following example visits all nodes in the view.

+ * +
  1. UIViewRoot + * root = + * facesContext.getViewRoot();
    2. + *
  2. root.visitTree(VisitContext.createVisitContext(context), + *
    3. + *
  3.            + *     new + * VisitCallback() + * {
    4. + *
  4.             + *        public VisitResult + * visit(VisitContext context,
    5. + *
  5.             + *                       + *           UIComponent + * target) + * {
    6. + *
  6.             + *            // take some + * action on target
    7. + *
  7.             + *            return + * VisitResult.ACCEPT;
    8. + *
  8.             + *        }
    9. + *
  9.            + *     }); + *
+ * +

+ * The following example visits two subtrees within the component view.

+ * +
  1. Set<String> + * toVisit = + * getSet("form1:optionsPanel", + * "form2:detailPanel");
    2. + *
  2. UIViewRoot root = + * facesContext.getViewRoot();
    3. + *
  3. root.visitTree(VisitContext.createVisitContext(context, + * toVisit, null), + *
    4. + *
  4.            + *     new + * VisitCallback() + * {
    5. + *
  5.             + *        public VisitResult + * visit(VisitContext context,
    6. + *
  6.             + *                       + *           UIComponent + * target) + * {
    7. + *
  7.             + *            // take some + * action on target
    8. + *
  8.             + *            return + * VisitResult.ACCEPT;
    9. + *
  9.             + *        }
    10. + *
  10.            + *     }); + *
+ * +

+ * Note that every child node of those two subtrees is visited.

+ * +
+ */ +package javax.faces.component.visit; diff --git a/impl/src/main/java/javax/faces/context/package-info.java b/impl/src/main/java/javax/faces/context/package-info.java new file mode 100644 index 0000000000..df43ff5f01 --- /dev/null +++ b/impl/src/main/java/javax/faces/context/package-info.java @@ -0,0 +1,9 @@ +/** + *

+ * + * Classes and interfaces defining per-request state information. The + * main class in this package is {@link javax.faces.context.FacesContext}, which + * is the access point for all per-request information, as well as the gateway + * to several other helper classes.

+ */ +package javax.faces.context; diff --git a/impl/src/main/java/javax/faces/convert/package-info.java b/impl/src/main/java/javax/faces/convert/package-info.java new file mode 100644 index 0000000000..e508495956 --- /dev/null +++ b/impl/src/main/java/javax/faces/convert/package-info.java @@ -0,0 +1,8 @@ +/** + *

+ * Contains + * classes and interfaces defining converters. The main class in this package is {@link + * javax.faces.convert.Converter}.

+ */ +package javax.faces.convert; diff --git a/impl/src/main/java/javax/faces/el/package-info.java b/impl/src/main/java/javax/faces/el/package-info.java new file mode 100644 index 0000000000..a252eda8d4 --- /dev/null +++ b/impl/src/main/java/javax/faces/el/package-info.java @@ -0,0 +1,9 @@ +/** + *

+ * DEPRECATED Classes and interfaces for evaluating and processing + * reference expressions. The main class in this package is + * {@link javax.faces.el.ValueBinding}, which is the runtime representation of a + * reference expression. ValueBinding provides methods to get and + * set the value of the expression.

+ */ +package javax.faces.el; diff --git a/impl/src/main/java/javax/faces/event/package-info.java b/impl/src/main/java/javax/faces/event/package-info.java new file mode 100644 index 0000000000..b66d7ed0cb --- /dev/null +++ b/impl/src/main/java/javax/faces/event/package-info.java @@ -0,0 +1,13 @@ +/** + *

+ * Interfaces + * describing events and event listeners, and concrete event implementation + * classes. All events extend from {@link javax.faces.event.FacesEvent} and all + * listeners extend from {@link javax.faces.event.FacesListener}.

+ *

+ * For your convenience here is a UML class diagram of the classes in this + * package.

+ * Event hierarchy + */ +package javax.faces.event; diff --git a/impl/src/main/java/javax/faces/flow/builder/package-info.java b/impl/src/main/java/javax/faces/flow/builder/package-info.java new file mode 100644 index 0000000000..81dcb1c904 --- /dev/null +++ b/impl/src/main/java/javax/faces/flow/builder/package-info.java @@ -0,0 +1,6 @@ +/** + *

Classes for declaring a Faces Flow. + * See {@link javax.faces.flow.builder.FlowBuilder} and its helpers + * for the normative specification of this feature.

+ */ +package javax.faces.flow.builder; diff --git a/impl/src/main/java/javax/faces/flow/package-info.java b/impl/src/main/java/javax/faces/flow/package-info.java new file mode 100644 index 0000000000..4cdb0d8874 --- /dev/null +++ b/impl/src/main/java/javax/faces/flow/package-info.java @@ -0,0 +1,8 @@ +/** + *

The + * runtime API for Faces Flows. See + * {@link javax.faces.flow.FlowHandler} and its helpers for + * the normative specification of this feature.

+ * Flow hierarchy + */ +package javax.faces.flow; diff --git a/impl/src/main/java/javax/faces/lifecycle/package-info.java b/impl/src/main/java/javax/faces/lifecycle/package-info.java new file mode 100644 index 0000000000..c27c724d78 --- /dev/null +++ b/impl/src/main/java/javax/faces/lifecycle/package-info.java @@ -0,0 +1,10 @@ +/** + *

+ * Classes and + * interfaces defining lifecycle management for the JavaServer Faces + * implementation. The main class in this package is + * {@link javax.faces.lifecycle.Lifecycle}. Lifecycle is the + * gateway to executing the request processing lifecycle. + *

+ */ +package javax.faces.lifecycle; diff --git a/impl/src/main/java/javax/faces/model/package-info.java b/impl/src/main/java/javax/faces/model/package-info.java new file mode 100644 index 0000000000..3afcc65100 --- /dev/null +++ b/impl/src/main/java/javax/faces/model/package-info.java @@ -0,0 +1,7 @@ +/** + *

+ * Standard model data + * beans for JavaServer Faces.

+ */ +package javax.faces.model; diff --git a/impl/src/main/java/javax/faces/package-info.java b/impl/src/main/java/javax/faces/package-info.java new file mode 100644 index 0000000000..d73ddc5380 --- /dev/null +++ b/impl/src/main/java/javax/faces/package-info.java @@ -0,0 +1,8 @@ +/** + * Top + * level classes for the JavaServer(tm) Faces API. The most important class in + * the package is {@link javax.faces.FactoryFinder}, which is the mechanism by + * which users can override many of the key pieces of the implementation with + * their own. + */ +package javax.faces; diff --git a/impl/src/main/java/javax/faces/push/package-info.java b/impl/src/main/java/javax/faces/push/package-info.java new file mode 100644 index 0000000000..48dce277e3 --- /dev/null +++ b/impl/src/main/java/javax/faces/push/package-info.java @@ -0,0 +1,6 @@ +/** + *

This package hosts the CDI annotation for + * injecting a PushContext. + *

+ */ +package javax.faces.push; diff --git a/impl/src/main/java/javax/faces/render/package-info.java b/impl/src/main/java/javax/faces/render/package-info.java new file mode 100644 index 0000000000..87575b07e8 --- /dev/null +++ b/impl/src/main/java/javax/faces/render/package-info.java @@ -0,0 +1,10 @@ +/** + *

+ * Classes + * and interfaces defining the rendering model. The main class in this package + * is {@link + * javax.faces.render.RenderKit}. RenderKit vends a set of + * {@link javax.faces.render.Renderer} instances which provide rendering + * capability for a specific client device type.

+ */ +package javax.faces.render; diff --git a/impl/src/main/java/javax/faces/validator/package-info.java b/impl/src/main/java/javax/faces/validator/package-info.java new file mode 100644 index 0000000000..bb5a120b32 --- /dev/null +++ b/impl/src/main/java/javax/faces/validator/package-info.java @@ -0,0 +1,8 @@ +/** + *

+ * Interface + * defining the validator model, and concrete validator implementation + * classes.

+ */ +package javax.faces.validator; diff --git a/impl/src/main/java/javax/faces/view/facelets/package-info.java b/impl/src/main/java/javax/faces/view/facelets/package-info.java new file mode 100644 index 0000000000..236ef36dac --- /dev/null +++ b/impl/src/main/java/javax/faces/view/facelets/package-info.java @@ -0,0 +1,27 @@ + +/** + *

This + * package contains public classes for the Java code API of Facelets. The vast + * majority of Facelets users have no need to access the Java API and can get + * all their work done using the tag-level API. These classes are provided for + * users that have a need for a Java API that allows participation in the + * execution of a Facelets View, which happens as a result of the runtime + * calling {@link javax.faces.view.ViewDeclarationLanguage#buildView(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot)}. + *

+ *
+ *

+ * UML Class Diagram of classes in this package + *

+ *

+ * The most common usecase for participating in the execution of a Facelets View + * is to provide a custom tag handler in those cases when the non-Java API + * methods for doing so is not sufficient. In such cases, Java classes may + * extend from {@link javax.faces.view.facelets.ComponentHandler}, {@link javax.faces.view.facelets.BehaviorHandler}, + * {@link javax.faces.view.facelets.ConverterHandler}, or {@link javax.faces.view.facelets.ValidatorHandler} depending upon the + * kind of JSF Java API artifact they want to represent in the Facelets VDL + * page.

+ * + *
+ */ +package javax.faces.view.facelets; diff --git a/impl/src/main/java/javax/faces/view/package-info.java b/impl/src/main/java/javax/faces/view/package-info.java new file mode 100644 index 0000000000..6833aa0f3e --- /dev/null +++ b/impl/src/main/java/javax/faces/view/package-info.java @@ -0,0 +1,10 @@ +/** + *

Classes for defining a View + * Declaration Language (VDL) for authoring JavaServer Faces user interfaces. + * The root class in this package is {@link ViewDeclarationLanguageFactory} + * Interfaces and classes required for the Facelets for JSF 2 implementation are + * also defined in package javax.faces.view.facelets.

+ */ +package javax.faces.view; diff --git a/impl/src/main/java/javax/faces/webapp/package-info.java b/impl/src/main/java/javax/faces/webapp/package-info.java new file mode 100644 index 0000000000..f24f292356 --- /dev/null +++ b/impl/src/main/java/javax/faces/webapp/package-info.java @@ -0,0 +1,10 @@ +/** + *

+ * Classes + * required for integration of JavaServer Faces into web applications, including + * a standard servlet, + * base classes for JSP custom component tags, + * and concrete tag implementations for core tags.

+ */ +package javax.faces.webapp; diff --git a/impl/src/main/javadoc/javax/faces/annotation/package.html b/impl/src/main/javadoc/javax/faces/annotation/package.html deleted file mode 100644 index 1cabab4197..0000000000 --- a/impl/src/main/javadoc/javax/faces/annotation/package.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - -

Annotations in this class allow injection -of JSF objects into CDI beans.

- - - diff --git a/impl/src/main/javadoc/javax/faces/application/package.html b/impl/src/main/javadoc/javax/faces/application/package.html deleted file mode 100644 index 454a8414ed..0000000000 --- a/impl/src/main/javadoc/javax/faces/application/package.html +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - - -

APIs that are used to link an application's -business logic objects to JavaServer Faces, as well as convenient -pluggable mechanisms to manage the execution of an application that is -based on JavaServer Faces. The main class in this package is {@link -javax.faces.application.Application}.

- - - diff --git a/impl/src/main/javadoc/javax/faces/bean/package.html b/impl/src/main/javadoc/javax/faces/bean/package.html deleted file mode 100644 index a133b7eaf1..0000000000 --- a/impl/src/main/javadoc/javax/faces/bean/package.html +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - - -

These javadoc files constitute the -“Faces Managed Bean Annotation Specification for Containers -Conforming to Servlet 2.5 and Beyond”

- -
- -

This package is now deprecated. The specification for managed beans -from JSF has been placed into its own specifications, namely Managed -Beans and CDI. -

- -

The annotations must be processed as specified in section JSF.11.5.1.

- - -
- - - diff --git a/impl/src/main/javadoc/javax/faces/component/behavior/package.html b/impl/src/main/javadoc/javax/faces/component/behavior/package.html deleted file mode 100644 index ff8b604c80..0000000000 --- a/impl/src/main/javadoc/javax/faces/component/behavior/package.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - -Package Description for "javax.faces.component.behavior" - - -

APIs for attaching additional -behavior to user interface components.

- - - - diff --git a/impl/src/main/javadoc/javax/faces/component/UIComponentHierarchy.jpg b/impl/src/main/javadoc/javax/faces/component/doc-files/UIComponentHierarchy.jpg similarity index 100% rename from impl/src/main/javadoc/javax/faces/component/UIComponentHierarchy.jpg rename to impl/src/main/javadoc/javax/faces/component/doc-files/UIComponentHierarchy.jpg diff --git a/impl/src/main/javadoc/javax/faces/component/html/package.html b/impl/src/main/javadoc/javax/faces/component/html/package.html deleted file mode 100644 index 3368609d9d..0000000000 --- a/impl/src/main/javadoc/javax/faces/component/html/package.html +++ /dev/null @@ -1,27 +0,0 @@ - - - - -Package Description for "javax.faces.component.html" - -

Specialized user -interface component classes for HTML.

- - - diff --git a/impl/src/main/javadoc/javax/faces/component/package.html b/impl/src/main/javadoc/javax/faces/component/package.html deleted file mode 100644 index d15e4db66a..0000000000 --- a/impl/src/main/javadoc/javax/faces/component/package.html +++ /dev/null @@ -1,36 +0,0 @@ - - - - -Package Description for "javax.faces.component" - - -

Fundamental APIs for user -interface components.

- -

For your convenience here is a UML class diagram of the classes in -this package.

- - - - - - diff --git a/impl/src/main/javadoc/javax/faces/component/search/package.html b/impl/src/main/javadoc/javax/faces/component/search/package.html deleted file mode 100644 index c439cc3f4d..0000000000 --- a/impl/src/main/javadoc/javax/faces/component/search/package.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - -Package Description for "javax.faces.component.search" - - -

APIs for searching for components in the -component tree by using expressions.

- -
- -

This feature has two entry points: for the page author and for the - Java programmer. Following is a brief overview of each.

- -

For the Page Author

- -

The following tags support the use of search - expressions: <h:message />, <h:messages - />, <h:outputLabel />, - and <f:ajax />. Each of those tags have one or - more attributes whose value must be a client identifier. This feature - expands the capability of those attributes to be search expressions. - A search expression is space separated list of tokens, where a token - can either be a client identifier, a search keyword, or a combination - of both. See the specification - for SearchKeywordResolver - for the list of keywords that must be supported. See the - specification - for SearchExpressionHandler - to learn how the search is performed.

- -

Here is a brief example of the page author use case:

- -
  1. <h:body>
    2. -
  2.   <h:outputLabel id="label" for="@next" value="Test" />
    3. -
  3.   <h:inputText id="input">
    4. -
  4.     <f:ajax render="@this @next" />
    5. -
  5.   </h:inputText>
    6. -
  6.   <h:inputText id="input2" />
    7. -
  7. </h:body>
- -

For the Java Programmer

- -

Using search expressions from Java code offers more flexibility. - One must obtain a handle to - the SearchExpressionHandler - and invoke methods on it as desired.

- -

The following example resolves to a clientId:

- -
-
-
    -
  1. SearchExpressionHandler handler = facesContext.getApplication().getSearchExpressionHandler();
    2. -
  2. SearchExpressionContext context = SearchExpressionContext.createSearchExpressionContext(facesContext, facesContext.getViewRoot());
    3. -
  3. String clientId = handler.resolveClientId(context, ":form:container:@next");
    4. -
-
-
- -

The following example resolves to a component:

- -
-
-
    -
  1. SearchExpressionHandler handler = facesContext.getApplication().getSearchExpressionHandler();
    2. -
  2. SearchExpressionContext context = SearchExpressionContext.createSearchExpressionContext(facesContext, facesContext.getViewRoot());
    3. -
  3. handler.resolveComponent(context, ":form:container:@next",
    4. -
  4.                new ContextCallback() {
    5. -
  5.                    public void invokeContextCallback(FacesContext context,
    6. -
  6.                                             UIComponent target) {
    7. -
  7.                        // target == the resolved component
    8. -
  8.                    }
    9. -
  9.                });
- -
- -

The following example uses multiple expressions and therefor resolves to multiple components:

- -
-
-
    -
  1. SearchExpressionHandler handler = facesContext.getApplication().getSearchExpressionHandler();
    2. -
  2. SearchExpressionContext context = SearchExpressionContext.createSearchExpressionContext(facesContext, facesContext.getViewRoot());
    3. -
  3. handler.resolveComponents(context, ":form:container:@next :input1 input2:@parent",
    4. -
  4.                new ContextCallback() {
    5. -
  5.                    public void invokeContextCallback(FacesContext context,
    6. -
  6.                                             UIComponent target) {
    7. -
  7.                        // target == the resolved component
    8. -
  8.                    }
    9. -
  9.                });
- -
- - -

Extending the Capabilities of the Component Search Facility

- -

Creation of the SearchExpressionContext

- -

As with other factories in JSF, the FactoryFinder is - used by the system to create instances of - the SearchExpressionContext which holds state during the - operation of this API.

- -

Adding new SearchKewordResolvers

- -

See SearchKeywordResolver - for the specification of how the set of keywords can be expanded.

- - - - - - diff --git a/impl/src/main/javadoc/javax/faces/component/visit/package.html b/impl/src/main/javadoc/javax/faces/component/visit/package.html deleted file mode 100644 index 8a126eeebd..0000000000 --- a/impl/src/main/javadoc/javax/faces/component/visit/package.html +++ /dev/null @@ -1,61 +0,0 @@ - - - - -Package Description for "javax.faces.component.visit" - - -

APIs for -traversing a user interface component view.

- -
- -

The following example visits all nodes in the view.

- -
  1. UIViewRoot root = facesContext.getViewRoot();
    2. -
  2. root.visitTree(VisitContext.createVisitContext(context),
    3. -
  3.                new VisitCallback() {
    4. -
  4.                    public VisitResult visit(VisitContext context,
    5. -
  5.                                             UIComponent target) {
    6. -
  6.                        // take some action on target
    7. -
  7.                        return VisitResult.ACCEPT;
    8. -
  8.                    }
    9. -
  9.                });
- -

The following example visits two subtrees within the component -view.

- -
  1. Set<String> toVisit = getSet("form1:optionsPanel", "form2:detailPanel");
    2. -
  2. UIViewRoot root = facesContext.getViewRoot();
    3. -
  3. root.visitTree(VisitContext.createVisitContext(context, toVisit, null),
    4. -
  4.                new VisitCallback() {
    5. -
  5.                    public VisitResult visit(VisitContext context,
    6. -
  6.                                             UIComponent target) {
    7. -
  7.                        // take some action on target
    8. -
  8.                        return VisitResult.ACCEPT;
    9. -
  9.                    }
    10. -
  10.                });
- -

Note that every child node of those two subtrees is visited.

- -
- - - - diff --git a/impl/src/main/javadoc/javax/faces/context/package.html b/impl/src/main/javadoc/javax/faces/context/package.html deleted file mode 100644 index 1a9f52f725..0000000000 --- a/impl/src/main/javadoc/javax/faces/context/package.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - -Package Description for "javax.faces.context" - - -

-Classes and interfaces -defining per-request state information. The main class in this package -is {@link javax.faces.context.FacesContext}, which is the access point -for all per-request information, as well as the gateway to several other -helper classes.

- - diff --git a/impl/src/main/javadoc/javax/faces/convert/package.html b/impl/src/main/javadoc/javax/faces/convert/package.html deleted file mode 100644 index 1992ba9643..0000000000 --- a/impl/src/main/javadoc/javax/faces/convert/package.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - - Package Description for "javax.faces.convert" - - - -

Contains classes and interfaces -defining converters. The main class in this package is {@link -javax.faces.convert.Converter}.

- - - diff --git a/impl/src/main/javadoc/javax/faces/el/package.html b/impl/src/main/javadoc/javax/faces/el/package.html deleted file mode 100644 index fedbb41d2a..0000000000 --- a/impl/src/main/javadoc/javax/faces/el/package.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - -Package Description for "javax.faces.el" - - -

DEPRECATED Classes and interfaces for evaluating and -processing reference expressions. The main class in this package is -{@link javax.faces.el.ValueBinding}, which is the runtime representation -of a reference expression. ValueBinding provides methods -to get and set the value of the expression.

- - diff --git a/impl/src/main/javadoc/javax/faces/event/EventHierarchy.jpg b/impl/src/main/javadoc/javax/faces/event/doc-files/EventHierarchy.jpg similarity index 100% rename from impl/src/main/javadoc/javax/faces/event/EventHierarchy.jpg rename to impl/src/main/javadoc/javax/faces/event/doc-files/EventHierarchy.jpg diff --git a/impl/src/main/javadoc/javax/faces/event/package.html b/impl/src/main/javadoc/javax/faces/event/package.html deleted file mode 100644 index f758c47a63..0000000000 --- a/impl/src/main/javadoc/javax/faces/event/package.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - -Package Description for "javax.faces.event" - - - -

Interfaces describing -events and event listeners, and concrete event implementation classes. -All events extend from {@link javax.faces.event.FacesEvent} and all -listeners extend from {@link javax.faces.event.FacesListener}.

- -

For your convenience here is a UML class diagram of the classes in -this package.

- - - - - diff --git a/impl/src/main/javadoc/javax/faces/flow/builder/package.html b/impl/src/main/javadoc/javax/faces/flow/builder/package.html deleted file mode 100644 index efce0c17d0..0000000000 --- a/impl/src/main/javadoc/javax/faces/flow/builder/package.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - -Package Description for "javax.faces.flow.builder" - - - -

Classes for declaring a Faces -Flow. See FlowBuilder and -its helpers for the normative specification of this feature.

- - - diff --git a/impl/src/main/javadoc/javax/faces/flow/FlowHierarchy.jpg b/impl/src/main/javadoc/javax/faces/flow/doc-files/FlowHierarchy.jpg similarity index 100% rename from impl/src/main/javadoc/javax/faces/flow/FlowHierarchy.jpg rename to impl/src/main/javadoc/javax/faces/flow/doc-files/FlowHierarchy.jpg diff --git a/impl/src/main/javadoc/javax/faces/flow/package.html b/impl/src/main/javadoc/javax/faces/flow/package.html deleted file mode 100644 index bafdd64b92..0000000000 --- a/impl/src/main/javadoc/javax/faces/flow/package.html +++ /dev/null @@ -1,33 +0,0 @@ - - - - -Package Description for "javax.faces.flow" - - - -

The -runtime API for Faces Flows. -See FlowHandler and its -helpers for the normative specification of this feature.

- - - - - diff --git a/impl/src/main/javadoc/javax/faces/lifecycle/package.html b/impl/src/main/javadoc/javax/faces/lifecycle/package.html deleted file mode 100644 index 37725d81d7..0000000000 --- a/impl/src/main/javadoc/javax/faces/lifecycle/package.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - -Package Description for "javax.faces.lifecycle" - - -

Classes and interfaces defining lifecycle management for the -JavaServer Faces implementation. The main class in this package is -{@link javax.faces.lifecycle.Lifecycle}. Lifecycle is the -gateway to executing the request processing lifecycle. -

- - diff --git a/impl/src/main/javadoc/javax/faces/model/package.html b/impl/src/main/javadoc/javax/faces/model/package.html deleted file mode 100644 index 3e16661740..0000000000 --- a/impl/src/main/javadoc/javax/faces/model/package.html +++ /dev/null @@ -1,27 +0,0 @@ - - - - -Package Description for "javax.faces.model" - -

Standard model data - beans for JavaServer Faces.

- - diff --git a/impl/src/main/javadoc/javax/faces/package.html b/impl/src/main/javadoc/javax/faces/package.html deleted file mode 100644 index bc6a12b987..0000000000 --- a/impl/src/main/javadoc/javax/faces/package.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - - -Top level classes for the -JavaServer(tm) Faces API. The most important -class in the package is {@link javax.faces.FactoryFinder}, which is the -mechanism by which users can override many of the key pieces of the -implementation with their own. - - - diff --git a/impl/src/main/javadoc/javax/faces/push/package.html b/impl/src/main/javadoc/javax/faces/push/package.html deleted file mode 100644 index 51bfbc7188..0000000000 --- a/impl/src/main/javadoc/javax/faces/push/package.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - - -

This package hosts the CDI annotation for -injecting a PushContext. -

- - - - diff --git a/impl/src/main/javadoc/javax/faces/render/package.html b/impl/src/main/javadoc/javax/faces/render/package.html deleted file mode 100644 index 9f5866ab1f..0000000000 --- a/impl/src/main/javadoc/javax/faces/render/package.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - -Package Description for "javax.faces.render" - - -

Classes - and interfaces -defining the rendering model. The main class in this package is {@link -javax.faces.render.RenderKit}. RenderKit vends a set of -{@link javax.faces.render.Renderer} instances which provide rendering -capability for a specific client device type.

- - diff --git a/impl/src/main/javadoc/javax/faces/validator/package.html b/impl/src/main/javadoc/javax/faces/validator/package.html deleted file mode 100644 index f60ba5cb0d..0000000000 --- a/impl/src/main/javadoc/javax/faces/validator/package.html +++ /dev/null @@ -1,28 +0,0 @@ - - - - - Package Description for "javax.faces.validator" - - -

Interface -defining the validator model, and concrete validator implementation classes.

- - diff --git a/impl/src/main/javadoc/javax/faces/view/facelets/Facelets.jpg b/impl/src/main/javadoc/javax/faces/view/facelets/doc-files/Facelets.jpg similarity index 100% rename from impl/src/main/javadoc/javax/faces/view/facelets/Facelets.jpg rename to impl/src/main/javadoc/javax/faces/view/facelets/doc-files/Facelets.jpg diff --git a/impl/src/main/javadoc/javax/faces/view/facelets/package.html b/impl/src/main/javadoc/javax/faces/view/facelets/package.html deleted file mode 100644 index 4ea42b5028..0000000000 --- a/impl/src/main/javadoc/javax/faces/view/facelets/package.html +++ /dev/null @@ -1,56 +0,0 @@ - - - - -Package Description for "javax.faces.view.facelets" - - - -

This package contains public classes for -the Java code API of Facelets. The vast majority of Facelets users have -no need to access the Java API and can get all their work done using the -tag-level API. These classes are provided for users that have a need -for a Java API that allows participation in the execution of a Facelets -View, which happens as a result of the runtime calling ViewDeclarationLanguage.buildView(). -

- -
- -

- -UML Class Diagram of classes in this package - -

- -

The most common usecase for participating in the execution of a -Facelets View is to provide a custom tag handler in those cases when the -non-Java API methods for doing so is not sufficient. In such cases, -Java classes may extend from ComponentHandler, BehaviorHandler, ConverterHandler, or ValidatorHandler depending upon -the kind of JSF Java API artifact they want to represent in the Facelets -VDL page.

- -
- - diff --git a/impl/src/main/javadoc/javax/faces/view/package.html b/impl/src/main/javadoc/javax/faces/view/package.html deleted file mode 100644 index c581e40b9f..0000000000 --- a/impl/src/main/javadoc/javax/faces/view/package.html +++ /dev/null @@ -1,35 +0,0 @@ - - - - -Package Description for "javax.faces.view" - - - -

Classes for defining a -View Declaration Language (VDL) for authoring JavaServer Faces user -interfaces. The root class in this package is ViewDeclarationLanguageFactory. -Interfaces and classes required for the Facelets for JSF 2 -implementation are also defined in package javax.faces.view.facelets.

- - - diff --git a/impl/src/main/javadoc/javax/faces/webapp/package.html b/impl/src/main/javadoc/javax/faces/webapp/package.html deleted file mode 100644 index c90cbbcb74..0000000000 --- a/impl/src/main/javadoc/javax/faces/webapp/package.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - -Package Description for "javax.faces.webapp" - - - -

Classes required for integration of -JavaServer Faces into web applications, including a standard servlet, -base classes for JSP custom component -tags, and concrete tag implementations for core tags.

- -