跳至主要内容

JSF 2.3: Component search expression framework

Component search expression framework

In before JSF versions, it uses an absolute hierarchical ID, or a relative local ID to locate a component, it is useful to rerender a component in an ajax request. For more flexible to query the component, JSF added @all, @form, @this expression to search the component to be rerendered.
JSF 2.3 extends these expression by introducing new Component search expression framework, which adds some useful and powerful keywords, and also provides APIs to define your own keywords in the expression.
The following table lists all new keywords added in JSF 2.3, it is just a copy from Arjan Tijms' blog entry: What's new in JSF 2.3.
Keyword Description
@child(n) The nth child of the base component
@composite The closest composite component ancestor of the base component
@id(id) All component descendants of the base component with the specified component id
@namingcontainer The closest NamingContainer ancestor of the base component
@next The next component in the view after the base component
@parent The parent of the base component
@previous The previous component to the base component
@root The UIViewRoot
Let's try to create a custom keyword to find the grant parent node of the certain component in the component tree.
Create a new SearchKeywordResolver.
public class GrandParentKeywordResolver extends SearchKeywordResolver {

    @Override
    public boolean isResolverForKeyword(SearchExpressionContext searchExpressionContext, String keyword) {
        return "grandParent".equals(keyword);
    }

    @Override
    public void resolve(SearchKeywordContext searchKeywordContext, UIComponent current, String keyword) {
        UIComponent parent = current.getParent();
        if (parent != null) {
            searchKeywordContext.invokeContextCallback(parent.getParent());
        } else {
            searchKeywordContext.setKeywordResolved(true);
        }
    }
}
Register it via a @WebListener class.
@WebListener
public class WebInit implements ServletContextListener {

    @Override
    public void contextInitialized(ServletContextEvent sce) {
        FacesContext.getCurrentInstance()
                .getApplication()
                .addSearchKeywordResolver(new GrandParentKeywordResolver());

    }
}
A simple facelets template.
<h:panelGroup id="panelgroup">
 <h:form id="form">
  <h:button id="button" outcome="foo2">Button foo</h:button>
  <h:commandButton id="commandButton" action="#{backingBean.foo()}" value="invoke foo"/>
  <h:outputText id="body" value="body"/>
 </h:form>
</h:panelGroup>
Get the grandParent id of the certain component at runtime.
public void foo() {
 SearchExpressionContext searchContext = createSearchExpressionContext(context, context.getViewRoot());

 context.getApplication()
   .getSearchExpressionHandler()
   .resolveComponent(
     searchContext,
     ":form:@parent",
     (c, target) -> out.print(":form:@parent -> "+target.getId()));

 context.getApplication()
   .getSearchExpressionHandler()
   .resolveComponent(
     searchContext,
     ":form:@grandParent",
     (c, target) -> out.print(":form:@grandParent -> "+target.getId()));
}
Grab the source codes from my github account, and have a try.

评论

此博客中的热门博文

Build a Reactive application with Angular 5 and Spring Boot 2.0

I have created a post to describe Reactive programming supports in Spring 5 and its subprojects, all codes of this article are updated the latest Spring 5 RELEASE, check spring-reactive-sample under my Github account. In this post, I will create a simple blog system, including: A user can sign in and sign out. An authenticated user can create a post. An authenticated user can update a post. Only the user who has ADMIN role can delete a post. All users(including anonymous users) can view post list and post details. An authenticated user can add his comments to a certain post. The backend will be built with the latest Spring 5 reactive stack, including: Spring Boot 2.0, at the moment the latest version is 2.0.0.M7 Spring Data MongoDB supports reactive operations for MongoDB Spring Session adds reactive support for WebSession Spring Security 5 aligns with Spring 5 reactive stack The frontend is an Angular based SPA and it will be generated by Angular CLI. The so...

Create a restful application with AngularJS and Zend 2 framework

Create a restful application with AngularJS and Zend 2 framework This example application uses AngularJS/Bootstrap as frontend and Zend2 Framework as REST API producer. The backend code This backend code reuses the database scheme and codes of the official Zend Tutorial, and REST API support is also from the Zend community. Getting Started with Zend Framework 2 Getting Started with REST and Zend Framework 2 Zend2 provides a   AbstractRestfulController   for RESR API producing. class AlbumController extends AbstractRestfulController { public function getList() { $results = $this->getAlbumTable()->fetchAll(); $data = array(); foreach ($results as $result) { $data[] = $result; } return new JsonModel(array( 'data' => $data) ); } public function get($id) { $album = $this->getAlbumTable()->getAlbum($id); return new JsonModel(array("data" =...

Auditing with Hibernate Envers

Auditing with Hibernate Envers The approaches provided in JPA lifecyle hook and Spring Data auditing only track the creation and last modification info of an Entity, but all the modification history are not tracked. Hibernate Envers fills the blank table. Since Hibernate 3.5, Envers is part of Hibernate core project. Configuration Configure Hibernate Envers in your project is very simple, just need to add   hibernate-envers   as project dependency. <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-envers</artifactId> </dependency> Done. No need extra Event listeners configuration as the early version. Basic Usage Hibernate Envers provides a simple   @Audited   annotation, you can place it on an Entity class or property of an Entity. @Audited private String description; If   @Audited   annotation is placed on a property, this property can be tracked. @Entity @Audited public clas...