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: MorphBuilder.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.parser.Node;
24  
25  /***
26   * <p>
27   * This Builder is mapped to the HTML span tag and will morph into any clay
28   * component defined by the <code>jsfid</code> attribute in the HTML element.
29   * For most of the builder there is an assumed mapping between the source and
30   * target but the HTML span can be mapped to any clay meta component graph. The
31   * {@link org.apache.shale.clay.parser.builder.chain.SpanBuilderRule} handle
32   * the association of the HTML node with this class.
33   * </p>
34   */
35  public class MorphBuilder extends Builder {
36  
37      /***
38       * <p>
39       * Returns the <code>jsfid</code> the
40       * {@link org.apache.shale.clay.config.beans.ElementBean} will take.
41       * </p>
42       *
43       * @param node markup
44       * @return jsfid
45       */
46      protected String getJsfid(Node node) {
47          return "morph";
48      }
49  
50      /***
51       * <p>
52       * Returns a bogus componentType that is overridden by the mapped component
53       * using the <code>jsfid</code> as an HTML attribute.
54       * </p>
55       *
56       * @param node markup
57       * @return component type
58       */
59      protected String getComponentType(Node node) {
60          return "javax.faces.Morph";
61      }
62  
63      /***
64       * <p>
65       * Returns <code>true</code> indicating that the JSF component mapped to
66       * this html span tag can have children.
67       * </p>
68       *
69       * @return <code>true</code>
70       */
71      public boolean isChildrenAllowed() {
72          return true;
73      }
74  
75  }