2009/05/20 - Apache Shale has been retired.

For more information, please explore the Attic.

View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to you under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  /*
19   * $Id: SelectItemsBuilder.java 464373 2006-10-16 04:21:54Z rahul $
20   */
21  package org.apache.shale.clay.parser.builder;
22  
23  import org.apache.shale.clay.config.beans.ElementBean;
24  import org.apache.shale.clay.parser.Node;
25  
26  /***
27   * <p>
28   * This is a {@link Builder} that will create a {@link ElementBean} for a JSF
29   * <code>javax.faces.SelectItems</code> component. This builder is mapped to a
30   * {@link Node} by the {@link OptionBuilderRule}.
31   * </p>
32   */
33  public class SelectItemsBuilder extends Builder {
34  
35      /***
36       * <p>
37       * Returns a <code>jsfid</code> used to populate the target
38       * {@link ElementBean}.
39       * </p>
40       *
41       * @param node markup
42       * @return jsfid
43       */
44      protected String getJsfid(Node node) {
45          return "selectItems";
46      }
47  
48      /***
49       * <p>
50       * Returns the JSF component type <code>javax.faces.SelectItems</code>
51       * that will be set to the target {@link ElementBean} and used to create
52       * options for a collection.
53       * </p>
54       *
55       * @param node markup
56       * @return component type
57       */
58      protected String getComponentType(Node node) {
59          return "javax.faces.SelectItems";
60      }
61  
62  
63      /***
64       * <p>Returns <code>true</code> by default meaning that the
65       * parent will render children.</p>
66       *
67       * @param node markup
68       * @param target child bean
69       * @return <code>false</code> if the node body should be ignored
70       */
71      protected boolean getBuildNodeBody(Node node, ElementBean target) {
72          if (target.getAllowBody() != null) {
73             return super.getBuildNodeBody(node, target);
74          }
75  
76          return true;
77      }
78  
79  
80  }