org.apache.myfaces.trinidad.config.RegionConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of trinidad-api Show documentation

Public API for the Apache MyFaces Trinidad project

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.myfaces.trinidad.config;

/**
 * Provides metadata about region definitions.
 * Here's a simple example of a region definition in region-metadata.xml:
 * 
 *  
 *  <component>
 *    <component-type>
 *      org.apache.myfaces.trinidaddemo.view.faces.region.stock
 *    </component-type>
 *    <component-extension>
 *      <region-jsp-ui-def>/regions/stock.jspx</region-jsp-ui-def>
 *    </component-extension>
 *  </component>
 * 
 * The regionType of a region is defined to be the 
 * componentType of that component.  
 */
public abstract class RegionConfig extends ComponentConfig
{
  protected RegionConfig()
  {
  }

  /**
   * Gets the URL of the jsp file that is used to render this region
   */
  public abstract String getJspUIDef();  
}