View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.myfaces.trinidad.config;
20  
21  /**
22   * Provides metadata about region definitions.
23   * Here's a simple example of a region definition in region-metadata.xml:
24   * 
25   * <pre> 
26   *  &lt;component&gt;
27   *    &lt;component-type&gt;
28   *      org.apache.myfaces.trinidaddemo.view.faces.region.stock
29   *    &lt;/component-type&gt;
30   *    &lt;component-extension&gt;
31   *      &lt;region-jsp-ui-def&gt;/regions/stock.jspx&lt;/region-jsp-ui-def&gt;
32   *    &lt;/component-extension&gt;
33   *  &lt;/component&gt;
34   * </pre>
35   * The regionType of a region is defined to be the 
36   * componentType of that component.  
37   */
38  public abstract class RegionConfig extends ComponentConfig
39  {
40    protected RegionConfig()
41    {
42    }
43  
44    /**
45     * Gets the URL of the jsp file that is used to render this region
46     */
47    public abstract String getJspUIDef();  
48  }